Asendia Close Shipment API

openapi: 3.2.0
info:
  title: Asendia Close Shipment API
  version: Parcel 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 CloseShipment across 2 of this provider''s published API definitions: asendia-a1-parcel-swagger.json, asendia-a1-parcel-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: CloseShipment
paths:
  /api/A1/CloseShipment/CloseShipment:
    post:
      tags:
      - CloseShipment
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/closeShipmentRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/closeShipmentRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/closeShipmentRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/closeShipmentRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/postCloseShipmentResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/postCloseShipmentResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/postCloseShipmentResponse'
      summary: Create api a1 close shipment close shipment
      x-summary-source: derived
      operationId: postApiA1CloseShipmentCloseShipment
      x-operation-id-source: derived
  /api/A1/CloseShipment/CloseDAShipment:
    post:
      tags:
      - CloseShipment
      requestBody:
        content:
          application/json-patch+json:
            schema:
              $ref: '#/components/schemas/CloseDAShipmentsRequest'
          application/json:
            schema:
              $ref: '#/components/schemas/CloseDAShipmentsRequest'
          text/json:
            schema:
              $ref: '#/components/schemas/CloseDAShipmentsRequest'
          application/*+json:
            schema:
              $ref: '#/components/schemas/CloseDAShipmentsRequest'
      responses:
        '200':
          description: Success
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/postCloseDAShipmentResponse'
            application/json:
              schema:
                $ref: '#/components/schemas/postCloseDAShipmentResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/postCloseDAShipmentResponse'
      summary: Create api a1 close shipment close da shipment
      x-summary-source: derived
      operationId: postApiA1CloseShipmentCloseDAShipment
      x-operation-id-source: derived
components:
  schemas:
    postCloseShipmentResponse:
      type: object
      properties:
        closeShipment:
          allOf:
          - $ref: '#/components/schemas/closeShipmentResponseModel'
        responseStatus:
          allOf:
          - $ref: '#/components/schemas/responseStatus'
      additionalProperties: false
    CloseDAShipmentRequest:
      required:
      - accountNumber
      - manifestDate
      - shipmentsToClose
      type: object
      properties:
        accountNumber:
          maxLength: 12
          type: string
        subAccountNumber:
          maxLength: 12
          type:
          - string
          - 'null'
        shippingLocation:
          type:
          - string
          - 'null'
        processingPoint:
          type:
          - string
          - 'null'
        manifestDate:
          type: string
          description: Expected formats are MM.dd.yyyy or MM/dd/yyyy or yyyy-MM-dd.
        trackingIdentifier:
          type:
          - string
          - 'null'
        transport:
          allOf:
          - $ref: '#/components/schemas/TransportData'
        customerReferenceNumber1:
          maxLength: 50
          type:
          - string
          - 'null'
        customerReferenceNumber2:
          maxLength: 50
          type:
          - string
          - 'null'
        customerReferenceNumber3:
          maxLength: 50
          type:
          - string
          - 'null'
        dhlbolNumber:
          type:
          - string
          - 'null'
        shipmentsToClose:
          type: array
          items:
            $ref: '#/components/schemas/shipmentsToClose'
      additionalProperties: false
    closeShipmentResponseModel:
      type: object
      properties:
        jobNumber:
          type:
          - string
          - 'null'
          description: Job number automatically assigned by A1
        jobStatus:
          type:
          - string
          - 'null'
          description: Job status. "Not received" if job is properly created (and is not direct access), "Not received" if created successfully but pickup mising, "Error-not created" or similar if request failed and job is not created. Or "Closed" for direct access
        jobCreationDate:
          type:
          - string
          - 'null'
          format: date-time
        jobProductCode:
          type:
          - string
          - 'null'
          description: job Product Code calculated by A1 according to parcels' Product Codes in the job
        jobProductName:
          type:
          - string
          - 'null'
          description: job Product name related to Product Code
        jobQuoteCode:
          type:
          - string
          - 'null'
          description: job Quote Code calculated by A1 according to parcels' Quote Codes in the job
        jobQuoteName:
          type:
          - string
          - 'null'
          description: job Quote name related to Quote Code
        jobTotalWeight:
          type:
          - number
          - 'null'
          description: job Weight Unit calculated by A1 according to sum of parcelWeights of parcels in the job
          format: double
        jobWeightUnit:
          allOf:
          - $ref: '#/components/schemas/weightUnitEnum'
          description: 'job weight unit (Lb or Kg) - same as weightUnit from parcels contained in the job.

            Possible values: [ Lb, Kg ]'
        jobTotalPieces:
          type:
          - integer
          - 'null'
          description: job Total Pieces calculated by A1 according to number or parcels in the job
          format: int32
        isDirectAccess:
          type:
          - boolean
          - 'null'
        packageUsedInAnotherJob:
          type:
          - array
          - 'null'
          items:
            type: string
        jobDocuments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/jobDocument'
          description: 'See jobDocuments object. Array can contain multiple entries.

            Contains delivery note (SCD) and possibly some manifests in case of Direct Access'
      additionalProperties: false
    jobDocument:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: ''
        type:
          allOf:
          - $ref: '#/components/schemas/labelTypeEnum'
          description: 'Possible values: [ PDF, PNG, ZPL, ANY ]'
        content:
          type:
          - string
          - 'null'
          description: ''
      additionalProperties: false
    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
    CloseDAShipmentsRequest:
      type: object
      properties:
        closeDAShipmentRequest:
          allOf:
          - $ref: '#/components/schemas/CloseDAShipmentRequest'
      additionalProperties: false
    postCloseDAShipmentResponse:
      type: object
      properties:
        responseStatus:
          allOf:
          - $ref: '#/components/schemas/responseStatus'
        closeDAShipment:
          allOf:
          - $ref: '#/components/schemas/closeDAShipmentResponseModel'
      additionalProperties: false
    closeShipmentRequestModel:
      required:
      - accountNumber
      - pickupCarrier
      type: object
      properties:
        accountNumber:
          maxLength: 12
          type: string
          description: Asendia's account number designated for the shipper. This will be provided at account setup.
        subAccountNumber:
          maxLength: 12
          type:
          - string
          - 'null'
          description: Asendia's sub account number designated for the shipper, if applicable. This will be provided at account setup.
        shippingLocation:
          type:
          - string
          - 'null'
          description: 'The location customer is shipping from: either customer drops off parcels from this shipping location to Asendia processing location or Asendia picks up parcels at this designated shipping location

            For each customer each location has a unique code and one of them is set as default location.

            For the default location, DEFAULT value can be used instead of location code which makes setup easier for customers with a unique location.

            If customer has several locations, field must be populated with the code of the location provided during onboarding phase.'
        processingPoint:
          type:
          - string
          - 'null'
        isDirectAccess:
          type:
          - boolean
          - 'null'
        pickupCarrier:
          type: string
          description: 'The Asendia''s location in where the physical package will be processed.

            Equivalent of "Pickup Carrier" field from Job creation but using codes rather than free text.

            - if customer drops himself shipments to processsing location, then pickupCarrier=CUSTDROPOFF (*)

            - if a pickup is requested, then pickupCarrier=ASPICKUP (*)

            - if Direct Access, then pickupCarrier=DIRECTA

            - if other carrier is concerned, use related code'
        trackingIdentifier:
          type:
          - string
          - 'null'
          description: Can be used in case of customer drop-off if a carrier is used for transport and provides a tracking number/identifier. Customer and Asendia can accordinglyu track shipment from customer location to Asendia processing location
        transportReference:
          type:
          - string
          - 'null'
          description: Used for Direct Access to capture transport or shipping reference such as MAWB number
        customerReferenceNumber1:
          maxLength: 50
          type:
          - string
          - 'null'
          description: Users have the option of entering notes for their own purposes in these three fields.  Any notes entered will display on the shipping control document (SCD), reports, and invoices.
        customerReferenceNumber2:
          maxLength: 50
          type:
          - string
          - 'null'
          description: Users have the option of entering notes for their own purposes in these three fields.  Any notes entered will display on the shipping control document (SCD), reports, and invoices.
        customerReferenceNumber3:
          maxLength: 50
          type:
          - string
          - 'null'
          description: Users have the option of entering notes for their own purposes in these three fields.  Any notes entered will display on the shipping control document (SCD), reports, and invoices.
        dhlbolNumber:
          type:
          - string
          - 'null'
          description: ''
        shipmentsToClose:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/shipmentsToClose'
          description: 'See shipmentsToClose object

            Array - list of parcels or orders or receptacles/containers or dispatches to be closed

            Must contain at least one number

            Each shipment can be identified using one of the following number types:

            - trackingNumber of a Parcel (retrieved from Create Parcel) if you want to close parcels one by one

            - or orderNumber (provided by customer in Create Parcel) if you want to close parcels using their order numbers - if several parcels have the same order number, they will all be closed except if a parcel was closed before

            - or containerNumber (provided by Create Container) if you want to close all parcels within a bag

            - or dispatchNumber (provided by customer in Create Parcel) if you want to close all parcels nested in the same customer dispatch

            Important: don''t mix number types in the same request so don''t provid a mix of tracking numbers and order numbers. Provide only tracking numbers or only order numbers or only dispatch numbers or only container numbers'
      additionalProperties: false
    weightUnitEnum:
      enum:
      - Lb
      - Lbs
      - Kg
      - Kgs
      - LB
      - LBS
      - KG
      - KGS
      type: string
    shipmentsToClose:
      type: object
      properties:
        trackingNumber:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: trackingNumber of a Parcel (retrieved from Create Parcel)
        packageId:
          maxLength: 50
          minLength: 0
          type:
          - string
          - 'null'
          description: packageId
        orderNumber:
          maxLength: 50
          type:
          - string
          - 'null'
          description: 'orderNumber (provided by customer in Create Parcel)

            If several parcels have the same order number, they will all be closed except if a parcel was closed before'
        containerNumber:
          maxLength: 50
          type:
          - string
          - 'null'
          description: 'containerNumber (provided by Create Container)

            You must provide at least one number and number types cannot be mixed: only trackingNumbers, or only orderNumbers, or only dispatchNumbers, or only containerNumbers'
        dispatchNumber:
          maxLength: 100
          type:
          - string
          - 'null'
          description: 'dispatchNumber (provided by customer in Create Parcel)

            You must provide at least one number and number types cannot be mixed: only trackingNumbers, or only orderNumbers, or only dispatchNumbers, or only containerNumbers'
      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
    closeShipmentRequest:
      type: object
      properties:
        closeShipmentsRequest:
          allOf:
          - $ref: '#/components/schemas/closeShipmentRequestModel'
      additionalProperties: false
    TransportData:
      type: object
      properties:
        transportReference:
          type:
          - string
          - 'null'
        flightNumber:
          type:
          - string
          - 'null'
        etd:
          type:
          - string
          - 'null'
        eta:
          type:
          - string
          - 'null'
        originPort:
          maxLength: 3
          type:
          - string
          - 'null'
        destinationPort:
          maxLength: 3
          type:
          - string
          - 'null'
      additionalProperties: false
    labelTypeEnum:
      enum:
      - PDF
      - PNG
      - ZPL
      - ZPL300
      - ANY
      type: string
      description: Format label return in response
    closeDAShipmentResponseModel:
      type: object
      properties:
        jobId:
          type: integer
          format: int32
        jobNumber:
          type:
          - string
          - 'null'
        jobStatus:
          type:
          - string
          - 'null'
        jobCreationDate:
          type: string
          format: date-time
        jobProductCode:
          type:
          - string
          - 'null'
        jobProductName:
          type:
          - string
          - 'null'
        jobQuoteCode:
          type:
          - string
          - 'null'
        jobQuoteName:
          type:
          - string
          - 'null'
        jobTotalWeight:
          type:
          - number
          - 'null'
          format: double
        jobTotalPieces:
          type: integer
          format: int32
        jobWeightUnit:
          allOf:
          - $ref: '#/components/schemas/weightUnitEnum'
        isDirectAccess:
          type: boolean
        packageUsedInAnotherJob:
          type:
          - array
          - 'null'
          items:
            type: string
        receptacleNumbers:
          type:
          - array
          - 'null'
          items:
            type: string
        serviceDispatchNumbers:
          type:
          - array
          - 'null'
          items:
            type: string
        shipmentDispatchNumber:
          type:
          - string
          - 'null'
        receptacleLabels:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/ReportData'
      additionalProperties: false
x-refined-from:
- asendia-a1-parcel-swagger.json
- asendia-a1-parcel-openapi.yml