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-receptaclesorting-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 Receptacle Sorting API
  version: Receptacle v1.0
  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 ReceptacleSorting across 2 of this provider''s published API definitions: asendia-a1-receptacle-swagger.json, asendia-a1-receptacle-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: ReceptacleSorting
paths:
  /api/A1/v1.0/ReceptacleSorting/CreateReceptacle:
    post:
      tags:
      - ReceptacleSorting
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/PostReceptacleApiModel'
          application/json:
            schema:
              $ref: '#/components/schemas/PostReceptacleApiModel'
          text/json:
            schema:
              $ref: '#/components/schemas/PostReceptacleApiModel'
          application/*+json:
            schema:
              $ref: '#/components/schemas/PostReceptacleApiModel'
      responses:
        '204':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateReceptacleResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateReceptacleResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateReceptacleResponse'
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/CreateReceptacleResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/CreateReceptacleResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/CreateReceptacleResponse'
      summary: Create api a1 receptacle sorting create receptacle
      x-summary-source: derived
      operationId: postApiA1V10ReceptacleSortingCreateReceptacle
      x-operation-id-source: derived
  /api/A1/v1.0/ReceptacleSorting/GetReceptacle:
    get:
      tags:
      - ReceptacleSorting
      parameters:
      - name: receptacle_number
        in: query
        schema:
          type: string
      - name: receptacleNumber
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/GetReceptacleResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/GetReceptacleResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/GetReceptacleResponse'
      summary: Get api a1 receptacle sorting get receptacle
      x-summary-source: derived
      operationId: getApiA1V10ReceptacleSortingGetReceptacle
      x-operation-id-source: derived
components:
  schemas:
    ReportData:
      required:
      - contentData
      - contentSize
      - contentTypeId
      - formatCode
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
        formatCode:
          type: string
        contentTypeId:
          type: integer
          format: int32
        contentTypeName:
          type:
          - string
          - 'null'
        contentSize:
          type: string
        createdOn:
          type:
          - string
          - 'null'
          format: date-time
        createdBy:
          type:
          - string
          - 'null'
        exportedOn:
          type:
          - string
          - 'null'
          format: date-time
        exportedBy:
          type:
          - string
          - 'null'
        friendlyName:
          type:
          - string
          - 'null'
        contentData:
          type: string
        reportId:
          type: integer
          format: int32
        fileName:
          type:
          - string
          - 'null'
        orientation:
          type:
          - string
          - 'null'
        fileLocationPath:
          type:
          - string
          - 'null'
        carrierLabelType:
          type:
          - string
          - 'null'
          description: A-Carrier document type when available (e.g. ACL Label.Type). Used to distinguish customs documents from shipping labels.
        isS3File:
          type: boolean
        numberOfCopies:
          type: integer
          format: int32
      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
    ReceptaclePackage:
      type: object
      properties:
        trackingNumberCustomer:
          type:
          - string
          - 'null'
        trackingNumber:
          type:
          - string
          - 'null'
        weight:
          type: number
          format: double
        piece:
          type: integer
          format: int32
        weightCode:
          type:
          - string
          - 'null'
        weightPostage:
          type: number
          format: double
        weightPostageCode:
          type:
          - string
          - 'null'
        phantomWeight:
          type: number
          format: double
        phantomWeightCode:
          type:
          - string
          - 'null'
        countryISO2:
          type:
          - string
          - 'null'
        countryName:
          type:
          - string
          - 'null'
        formatTypeId:
          type: integer
          format: int32
        formatName:
          type:
          - string
          - 'null'
        itemCount:
          type: integer
          format: int32
        value:
          type: number
          format: double
        processedBy:
          type:
          - string
          - 'null'
        processedOn:
          type: string
          format: date-time
        sortedBy:
          type:
          - string
          - 'null'
        sortedOn:
          type: string
          format: date-time
        dataSource:
          type:
          - string
          - 'null'
        untrackedItemId:
          type:
          - integer
          - 'null'
          format: int32
        sorting:
          type:
          - boolean
          - 'null'
        coreProductId:
          type: integer
          format: int32
        revenueProtection:
          type:
          - boolean
          - 'null'
      additionalProperties: false
    GetReceptacleResponse:
      type: object
      properties:
        receptacle:
          allOf:
          - $ref: '#/components/schemas/Receptacle'
        responseStatus:
          allOf:
          - $ref: '#/components/schemas/responseStatus'
      additionalProperties: false
    CreateReceptacleResponse:
      type: object
      properties:
        responseStatus:
          allOf:
          - $ref: '#/components/schemas/responseStatus'
        receptacle:
          allOf:
          - $ref: '#/components/schemas/Receptacle'
      additionalProperties: false
    Receptacle:
      type: object
      properties:
        carrierServiceDispatchId:
          type: integer
          format: int32
        carrierServiceDispatchReceptacleId:
          type: integer
          format: int32
        sequence:
          type: integer
          format: int32
        statusId:
          type: integer
          format: int32
        carrierId:
          type: integer
          format: int32
        carrierName:
          type:
          - string
          - 'null'
        carrierServiceId:
          type: integer
          format: int32
        carrierServiceName:
          type:
          - string
          - 'null'
        receptacleNumber:
          type:
          - string
          - 'null'
        carrierReceptacleNumber:
          type:
          - string
          - 'null'
        formatTypeId:
          type: integer
          format: int32
        formatName:
          type:
          - string
          - 'null'
        receptacleFormatTypeId:
          type: integer
          format: int32
        receptacleformatName:
          type:
          - string
          - 'null'
        containerTypeId:
          type: integer
          format: int32
        containerTypeName:
          type:
          - string
          - 'null'
        weightCode:
          allOf:
          - $ref: '#/components/schemas/weightTypeEnum'
        countryISO2:
          type:
          - string
          - 'null'
        countryOrZoneName:
          type:
          - string
          - 'null'
        foe:
          type:
          - string
          - 'null'
        priceGroup:
          type:
          - string
          - 'null'
        label:
          type:
          - string
          - 'null'
        minimumWeight:
          type: number
          format: double
        maximumWeight:
          type: number
          format: double
        createdOn:
          type: string
          format: date-time
        createdBy:
          type:
          - string
          - 'null'
        createdWorkStation:
          type:
          - string
          - 'null'
        closedOn:
          type: string
          format: date-time
        closedBy:
          type:
          - string
          - 'null'
        closedWorkstation:
          type:
          - string
          - 'null'
        receptaclePackages:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReceptaclePackage'
        receptacleLabels:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReportData'
        locationCarrierServicePermitId:
          type: integer
          format: int32
        piece:
          type: integer
          format: int32
        weight:
          type: number
          format: double
        isEnabled:
          type: integer
          format: int32
        labelQuantity:
          type:
          - integer
          - 'null'
          format: int32
        brokerId:
          type:
          - integer
          - 'null'
          format: int32
        brokerServiceId:
          type:
          - integer
          - 'null'
          format: int32
        postalDispatchId:
          type: integer
          format: int32
        hubTicketId:
          type:
          - integer
          - 'null'
          format: int32
        postalDispatchesMappingId:
          type:
          - integer
          - 'null'
          format: int32
        originImpc:
          type:
          - string
          - 'null'
        destinationImpc:
          type:
          - string
          - 'null'
        mailCategory:
          type:
          - string
          - 'null'
        mailSubclass:
          type:
          - string
          - 'null'
        postalFormat:
          type:
          - string
          - 'null'
        locationId:
          type:
          - integer
          - 'null'
          format: int32
        dispatchNumber:
          type:
          - string
          - 'null'
        internalServiceNoteId:
          type:
          - integer
          - 'null'
          format: int32
        flightTruckNumber:
          type:
          - string
          - 'null'
        nesDocumentStatusId:
          type:
          - integer
          - 'null'
          format: int32
        receptacleGroup:
          type:
          - string
          - 'null'
        crmId:
          type:
          - string
          - 'null'
        receptacleTierId:
          type:
          - integer
          - 'null'
          format: int32
        receptacleTierName:
          type:
          - string
          - 'null'
        isFinalized:
          type: boolean
        receptacleRouteCode:
          type:
          - string
          - 'null'
        destinationCode:
          type:
          - string
          - 'null'
        dispatchingSystem:
          type:
          - string
          - 'null'
        receptacleJobType:
          type: integer
          format: int32
        dispatchMappingFormat:
          type:
          - string
          - 'null'
        sequenceNumber:
          type: integer
          format: int32
        sequenceNumberDispatch:
          type: integer
          format: int32
      additionalProperties: false
    weightTypeEnum:
      enum:
      - lb
      - kg
      type: string
    PostReceptacleApiModel:
      required:
      - mdmServiceId
      - originSender
      - postalFormat
      - receptacleNumber
      - receptacleType
      - receptacleWeight
      type: object
      properties:
        receptacleNumber:
          minLength: 0
          type: string
        receptacleWeight:
          maximum: 10000000000
          minimum: 0.01
          type: number
          format: double
        originSender:
          maxLength: 6
          type: string
        internalServiceNote:
          type:
          - string
          - 'null'
        mdmServiceId:
          minLength: 0
          type: string
        receptacleType:
          type: integer
          format: int32
        postalFormat:
          type: string
        itemIds:
          type:
          - array
          - 'null'
          items:
            type: string
      additionalProperties: false
x-refined-from:
- asendia-a1-receptacle-swagger.json
- asendia-a1-receptacle-openapi.yml