DSV Orders API

openapi: 3.2.0
info:
  title: SCM Orders API
  description: test - Submit purchase orders to SCM and request updates via the Orders API\n
  version: v2
servers:
- url: https://api.dsv.com/om/v2
security:
- apiKeyHeader: []
- apiKeyQuery: []
tags:
- name: Orders
paths:
  /Orders/id/{id}:
    get:
      tags:
      - Orders
      summary: 6. Get order by guid/uuid.
      description: Get order by guid/uuid
      operationId: GETapi-public-v2-Orders-id-id
      parameters:
      - name: id
        in: path
        description: Format - uuid.
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        schema:
          enum:
          - application/json
          type: string
      - name: Accept
        in: header
        required: true
        schema:
          enum:
          - application/json
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/eDC.Web.Api.v2.Models.OrderDto'
  /Orders/{orderNumber}/{splitNo}:
    get:
      tags:
      - Orders
      summary: 5. Get order by order number and split number
      description: Get order by order number and split number
      operationId: GETapi-public-v2-Orders-orderNumber-splitNo
      parameters:
      - name: orderNumber
        in: path
        required: true
        schema:
          type: string
      - name: splitNo
        in: path
        description: Format - int64.
        required: true
        schema:
          type: integer
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        schema:
          enum:
          - application/json
          type: string
      - name: Accept
        in: header
        required: true
        schema:
          enum:
          - application/json
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/eDC.Web.Api.v2.Models.OrderDto'
    delete:
      tags:
      - Orders
      summary: 7. Delete order by order number and split number
      description: Delete order by order number and split number
      operationId: DELETEapi-public-v2-Orders-orderNumber-splitNo
      parameters:
      - name: orderNumber
        in: path
        required: true
        schema:
          type: string
      - name: splitNo
        in: path
        description: Format - int64.
        required: true
        schema:
          type: integer
      responses:
        '200':
          description: Success
  /Orders/{orderNumber}:
    get:
      tags:
      - Orders
      summary: 4. Get orders by order number
      description: Get orders by order number
      operationId: GETapi-public-v2-Orders-orderNumber
      parameters:
      - name: orderNumber
        in: path
        required: true
        schema:
          type: string
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        schema:
          enum:
          - application/json
          type: string
      - name: Accept
        in: header
        required: true
        schema:
          enum:
          - application/json
          type: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/eDC.Web.Api.v2.Models.OrderDto'
  /Orders:
    post:
      tags:
      - Orders
      summary: 1. Create Order(s)
      description: Create Order(s)
      operationId: POSTapi-public-v2-Orders
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        schema:
          enum:
          - application/json
          type: string
      - name: Accept
        in: header
        required: true
        schema:
          enum:
          - application/json
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eDC.Web.Api.v2.Models.OrderDto'
      responses:
        '200':
          description: Success
  /Orders/SearchCriteria:
    post:
      tags:
      - Orders
      summary: 3. Search for Orders by criteria
      description: Search for Orders by criteria
      operationId: POSTapi-public-v2-Orders-SearchCriteria
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        schema:
          enum:
          - application/json
          type: string
      - name: Accept
        in: header
        required: true
        schema:
          enum:
          - application/json
          type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Search.SearchRequest'
            example:
              grid:
                Page: 0
                PageSize: 0
                Sorts:
                - Member: string
                  SortDirection: Ascending
                Filters:
                - {}
                Groups:
                - MemberType: string
                  DisplayContent: {}
                  AggregateFunctions:
                  - AggregateMethodName: string
                    Caption: string
                    SourceField: string
                    FunctionName: string
                    MemberType: string
                    ResultFormatString: string
                  Member: string
                  SortDirection: Ascending
                Aggregates:
                - Aggregates:
                  - AggregateMethodName: string
                    Caption: string
                    SourceField: string
                    FunctionName: string
                    MemberType: string
                    ResultFormatString: string
                  Member: string
              criteria: string
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/eDC.Web.Api.v2.Models.OrderDto'
  /api/public/v2/Orders/ProcessOrderEDI:
    post:
      tags:
      - Orders
      summary: 8. ProcessOrderEDI
      description: ProcessOrderEDI
      operationId: POSTapi-public-v2-Orders-ProcessOrderEDI
      parameters:
      - name: Authorization
        in: header
        required: true
        schema:
          type: string
      - name: Content-Type
        in: header
        required: true
        schema:
          enum:
          - application/json
          type: string
      - name: Accept
        in: header
        required: true
        schema:
          enum:
          - application/json
          type: string
      responses:
        '200':
          description: Success
components:
  schemas:
    eDC.Domain.Enums.OrderState:
      enum:
      - Provisional
      - Open
      - Confirmed
      - OnHand
      - BookingProvisional
      - BookingPreBooked
      - BookingBooked
      - BookingRejected
      - BookingApproved
      - BookingConfirmed
      - BookingParked
      - PendingConsolidation
      - Planning
      - Planned
      - Consolidated
      - PendingCollection
      - Collected
      - BookingOnHand
      - DepartedOriginCFS
      - Shipped
      - Arrived
      - CustomsCommenced
      - CustomsCleared
      - AvailableDestinationCFS
      - PendingDelivery
      - DepartedDestinationCFS
      - Handover
      - Delivered
      - Fulfilled
      - Suspended
      - Cancelled
      type: string
      format: int32
    eDC.Web.Api.v2.Models.Entities.Booking:
      type: object
      properties:
        bookingNumber:
          type:
          - string
          - 'null'
          description: Booking Number
        externalBookingNumber:
          type:
          - string
          - 'null'
          description: External Booking Number
        externalBookingSender:
          type:
          - string
          - 'null'
          description: External Booking Sender
        state:
          $ref: '#/components/schemas/eDC.Domain.Enums.BookingState'
        origin:
          type:
          - string
          - 'null'
          description: Origin of the Booking
        destination:
          type:
          - string
          - 'null'
          description: Destination of the Booking
        incoterm:
          type:
          - string
          - 'null'
          description: Incoterm of the Booking
        additionalTerms:
          type:
          - string
          - 'null'
          description: Additional Terms of the Booking
        additionalTermsUNLOCO:
          type:
          - string
          - 'null'
          description: UN Location Code
        freightTerm:
          type:
          - string
          - 'null'
          description: Freight Terms
        orderNumbers:
          type:
          - string
          - 'null'
          description: Order Numbers
        unitOfWeight:
          type:
          - string
          - 'null'
          description: Unit of Measure for Weight
        weight:
          type: number
          description: Weight
          format: double
        unitOfVolume:
          type:
          - string
          - 'null'
          description: Unit of Measure for Volume
        volume:
          type: number
          description: Volume
          format: double
        noOfPieces:
          type: integer
          description: Number of Pieces
          format: int32
        orderCurrency:
          type:
          - string
          - 'null'
          description: Currency for the Order
        totalValue:
          type: number
          description: Total Value of the Order
          format: double
        packingWeight:
          type: number
          description: Packing Weight
          format: double
        packingVolume:
          type: number
          description: Packing Volume
          format: double
        transitWarehouse:
          type:
          - string
          - 'null'
          description: Transit Warehouse
        onHandDate:
          type:
          - string
          - 'null'
          description: On Hand Date
          format: date-time
        preBooked:
          type:
          - string
          - 'null'
          format: date-time
        bookedDate:
          type:
          - string
          - 'null'
          description: Date of Booking
          format: date-time
        rejectedDate:
          type:
          - string
          - 'null'
          description: Date of Booking Rejection
          format: date-time
        approvedDate:
          type:
          - string
          - 'null'
          description: Date of Booking Approval
          format: date-time
        confirmedDate:
          type:
          - string
          - 'null'
          description: Date of Booking Confirmation
          format: date-time
        cancelledDate:
          type:
          - string
          - 'null'
          description: Date of Booking Cancellation
          format: date-time
        countOfTEU:
          type: number
          description: TEU count
          format: double
        countOf20FT:
          type: integer
          description: Count of 20ft Container
          format: int32
        countOf40FT:
          type: integer
          description: Count of 40ft Container
          format: int32
        countOf45FT:
          type: integer
          description: Count of 45ft Container
          format: int32
        source:
          type:
          - string
          - 'null'
          description: Source
        systemID:
          type:
          - string
          - 'null'
          description: System ID
          format: uuid
        isApprovalRequired:
          type: boolean
          description: Boolean if Approval is required
        transitWarehouseDescription:
          type:
          - string
          - 'null'
          description: Transit Warehouse Description
        estimatedDeliveryDate:
          type:
          - string
          - 'null'
          description: Estimated Delivery Date
          format: date-time
        collectionRequiredDate:
          type:
          - string
          - 'null'
          description: Collection Required Date
          format: date-time
        collectionRequiredDateBy:
          type:
          - string
          - 'null'
          description: Collection Required Date By
          format: date-time
        deliveryRequiredDate:
          type:
          - string
          - 'null'
          description: Delivery Required Date
          format: date-time
        deliveryRequiredDateBy:
          type:
          - string
          - 'null'
          description: Delivery Required Date By
          format: date-time
        isCancelled:
          type: boolean
          description: Boolean if cancelled
        shipmentNumbers:
          type:
          - string
          - 'null'
          description: Shipment Number
        noOfContainers:
          type: integer
          description: Number of Containers
          format: int32
        ownership:
          type:
          - string
          - 'null'
          description: Ownership
        bookingDeliveryInstructions:
          type:
          - string
          - 'null'
          description: Booking Delivery Instruction
        requiredDepartureWeekNumber:
          type:
          - integer
          - 'null'
          description: Required Departure Week Number
          format: int32
        requiredArrivalWeekNumber:
          type:
          - integer
          - 'null'
          description: Required Arrival Week Number
          format: int32
        cargoReadyDateWeekNumber:
          type:
          - integer
          - 'null'
          description: Cargo Ready Date Week Number
          format: int32
        deliveryDateWeekNumber:
          type:
          - integer
          - 'null'
          description: Delivery Date Week Number
          format: int32
        estimatedDeliveryToOriginCFSWeekNumber:
          type:
          - integer
          - 'null'
          description: Estimated Delivery To Origin CFS Week Number
          format: int32
        supplierRef:
          type:
          - string
          - 'null'
          description: Supplier Reference
        requiredExFactory:
          type:
          - string
          - 'null'
          description: Required Ex Works Date
          format: date-time
        requiredInStore:
          type:
          - string
          - 'null'
          description: Required in Store Date
          format: date-time
        requestedDepartureDate:
          type:
          - string
          - 'null'
          description: Requested Departure Date
          format: date-time
        requestedArrivalDate:
          type:
          - string
          - 'null'
          description: Requested Arrival Date
          format: date-time
        transportMode:
          type:
          - string
          - 'null'
          description: Mode of Transport
        containerMode:
          type:
          - string
          - 'null'
          description: Container Mode
        goodsDescription:
          type:
          - string
          - 'null'
          description: Description of Goods
        marksAndNumbers:
          type:
          - string
          - 'null'
          description: Marks and Numbers
        bookingInstructions:
          type:
          - string
          - 'null'
          description: Booking Instructions
        loadingMeters:
          type: number
          description: Loading Meters
          format: double
        commodityCode:
          type:
          - string
          - 'null'
          description: Commodity Code
        plannerCode:
          type:
          - string
          - 'null'
          description: Planner Code
        plannerEmail:
          type:
          - string
          - 'null'
          description: Planner Email
        loadPort:
          type:
          - string
          - 'null'
          description: Port  of loading
        dischargePort:
          type:
          - string
          - 'null'
          description: Port of discharge
        sdocComplete:
          type:
          - string
          - 'null'
          format: date-time
        estimatedDeliveryToOriginCFS:
          type:
          - string
          - 'null'
          description: Estimated Delivery To Origin CFS Date
          format: date-time
        isPickupRequired:
          type: boolean
          description: Boolean for Pickup required
        shippingInstructions:
          type:
          - string
          - 'null'
          description: Shipment Instructions
        customerDivision:
          type:
          - string
          - 'null'
        carrierSpaceReservation:
          type:
          - string
          - 'null'
          format: date-time
        followUpDate:
          type:
          - string
          - 'null'
          format: date-time
        dateModified:
          type:
          - string
          - 'null'
          description: Date Modified
          format: date-time
        userModified:
          type:
          - string
          - 'null'
          description: User Modified
        dateCreated:
          type:
          - string
          - 'null'
          description: Date Created
          format: date-time
        userCreated:
          type:
          - string
          - 'null'
          description: User Created
        isSuspended:
          type: boolean
        suspendedDate:
          type:
          - string
          - 'null'
          format: date-time
        loadPlanNumber:
          type:
          - string
          - 'null'
        shipmentNumber:
          type:
          - string
          - 'null'
        temperatureControl:
          $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.TemperatureControl'
        customFields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.GenCustomAddOnValue'
          description: Custom Fields
        additionalReferences:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.AdditionalReference'
        parties:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.Company'
          description: Parties
        packLines:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.JobPackLine'
          description: Pack Lines
        equipmentTypes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.EquipmentType'
          description: Equipment Types
        notes:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.Note'
          description: Notes
        events:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.Event'
          description: Events
        shipments:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.Shipment'
      additionalProperties: false
    eDC.Web.Api.v2.Models.Entities.OrderItem:
      type: object
      properties:
        lineStatus:
          type:
          - string
          - 'null'
          description: 'Line Status: PLC for Placed, DLV for Delivered.'
        lineNo:
          type: integer
          description: Order Line Number.  Must be an integer, unique to the respective Order.
          format: int64
        partno:
          type:
          - string
          - 'null'
          description: Part No, Product Code or SKU Number.
        description:
          type:
          - string
          - 'null'
          description: Description of the part.
        unitOfQuantity:
          type:
          - string
          - 'null'
          description: 'The unit, such as: EA = Each.'
        quantity:
          type:
          - number
          - 'null'
          description: Quantity Ordered.
          format: double
        qtyInvoiced:
          type:
          - number
          - 'null'
          description: Quantity Invoiced / Booked by the Supplier.
          format: double
        qtyBooked:
          type:
          - number
          - 'null'
          description: Quantity Invoiced / Booked by the Supplier.
          format: double
        qtyReceived:
          type:
          - number
          - 'null'
          description: Quantity Received at the destination warehouse.
          format: double
        qtyShipped:
          type:
          - number
          - 'null'
          description: Quantity checked by the Control Tower to actually be Booked.
          format: double
        quantityRemaining:
          type:
          - number
          - 'null'
          description: Only applicable for Blanket Purchase Orders.
          format: double
        volume:
          type: number
          description: The total volume of the Order.
          format: double
        unitOfVolume:
          type:
          - string
          - 'null'
          description: The unit of volume.
        weight:
          type: number
          description: The total weight of the Order.
          format: double
        unitOfWeight:
          type:
          - string
          - 'null'
          description: Unit of weight
        itemPrice:
          type: number
          description: Price of the individual item
          format: double
        linePrice:
          type: number
          description: Price of the line, which is the the individual item, times the number of pieces
          format: double
        length:
          type: number
          description: Length of the item.
          format: double
        width:
          type: number
          description: Width of the item.
          format: double
        height:
          type: number
          description: Height of the item.
          format: double
        dimUnit:
          type:
          - string
          - 'null'
          description: Unit of Dimension, applicable to the Length, Width and Height
        dangerousGoodsRef:
          type:
          - string
          - 'null'
        containerNumber:
          type:
          - string
          - 'null'
        harmonisedCode:
          type:
          - string
          - 'null'
        ncmCode:
          type:
          - string
          - 'null'
        packLineId:
          type:
          - string
          - 'null'
        invoiceNumber:
          type:
          - string
          - 'null'
        confirmationNumber:
          type:
          - string
          - 'null'
        partAttrib1:
          type:
          - string
          - 'null'
        partAttrib2:
          type:
          - string
          - 'null'
        partAttrib3:
          type:
          - string
          - 'null'
        specialInstructions:
          type:
          - string
          - 'null'
        additionalInformation:
          type:
          - string
          - 'null'
        lineFreightCost:
          type: number
          format: double
        lineLandedCost:
          type: number
          format: double
        itemFreightCost:
          type: number
          format: double
        itemLandedCost:
          type: number
          format: double
        lineWeight:
          type: number
          format: double
        lineVolume:
          type: number
          format: double
        contractNumber:
          type:
          - string
          - 'null'
        isContainerAllocated:
          type: boolean
        batchID:
          type:
          - string
          - 'null'
        serialNo:
          type:
          - string
          - 'null'
        originCountry:
          type:
          - string
          - 'null'
        decimalPlaces:
          type: integer
          format: int32
        quantityPerUnit:
          type: number
          format: double
        netWeight:
          type: number
          format: double
        transportMode:
          type:
          - string
          - 'null'
        earliestShipDate:
          type:
          - string
          - 'null'
          format: date-time
        latestShipDate:
          type:
          - string
          - 'null'
          format: date-time
        freightClass:
          type:
          - string
          - 'null'
        serviceLevel:
          type:
          - string
          - 'null'
        ediSequence:
          type: integer
          format: int32
        inners:
          $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.Measurement'
        outers:
          $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.Measurement'
        qtyRemaining:
          type: number
          format: double
        qtyShippedRemaining:
          type: number
          format: double
        qtyInvoicedRemaining:
          type: number
          format: double
        qtyNotInvoiced:
          type: number
          format: double
        parties:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.Company'
        isCancelled:
          type: boolean
        estimatedExWorksDate:
          type:
          - string
          - 'null'
          format: date-time
        requiredExWorks:
          type:
          - string
          - 'null'
          format: date-time
        requiredInStore:
          type:
          - string
          - 'null'
          format: date-time
        notAuthorisedToShip:
          type:
          - string
          - 'null'
          format: date-time
        piecesPerUnit:
          type: number
          format: double
        refNumber:
          type:
          - string
          - 'null'
        customFields:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.GenCustomAddOnValue'
        events:
          type:
          - array
          - 'null'
          items:
            $ref: '#/components/schemas/eDC.Web.Api.v2.Models.Entities.Event'
        dateModified:
          type:
          - string
          - 'null'
          format: date-time
        userModified:
          type:
          - string
          - 'null'
        dateCreated:
          type:
          - string
          - 'null'
          format: date-time
        userCreated:
          type:
          - string
          - 'null'
        writeDownQuantity:
          type:
          - number
          - 'null'
          format: double
      additionalProperties: false
    eDC.Web.Api.v2.Models.Entities.DangerousGoods:
      type: object
      properties:
        regulation:
          type:
          - string
          - 'null'
        hazardClass:
          type:
          - string
          - 'null'
        additionalHazardClass:
          type:
          - string
          - 'null'
        classificationCode:
          type:
          - string
          - 'null'
        undgNumber:
          type:
          - string
          - 'null'
        variant:
          type:
          - string
          - 'null'
        psn:
          type:
          - string
          - 'null'
        technicalName:
          type:
          - string
          - 'null'
        labels:
          type:
          - string
          - 'null'
        packingGroup:
          type:
          - string
          - 'null'
        upperPlate:
          type:
          - string
          - 'null'
        lowerPlate:
          type:
          - string
          - 'null'
        numberOfPackages:
          type:
          - string
          - 'null'
        packageType:
          type:
          - string
          - 'null'
        packagingInstruction:
          type:
          - string
          - 'null'
        transportMeansCategory:
          type:
          - string
          - 'null'
        grossWeight:
          type: number
          format: double
        netWeight:
          type: number
          format: double
        explosiveWeight:
          type: number
          format: double
        unitOfWeight:
          type:
          - string
          - 'null'
        flashPointTemperature:
          type:
          - string
          - 'null'
        flashPointTemperatureUnit:
          type:
          - string
          - 'null'
        flashPointDescription:
          type:
          - string
          - 'null'
        tremCardNumber:
          type:
          - string
          - 'null'
        emsNumber:
          type:
          - string
          - 'null'
        mfagNumber:
          type:
          - string
          - 'null'
        marinePollutant:
          type:
          - string
          - 'null'
        limitedQuantity:
          type: boolean
        tunnelCode:
          type:
          - string
          - 'null'
        remarks:
          type:
          - string
          - 'null'
        contactName:
          type:
          - string
          - 'null'
        contactEmail:
          type:
          - string
          - 'null'
      additionalProperties: false
    eDC.Web.Api.v2.Models.Search.ListSortDirection:
      enum:
      - Ascending
      - Descending
      type: string
      format: int32
    eDC.Web.Api.v2.Models.Entities.Shipment:
      type: object
      properties:
        isCancelled:
          type: boolean
        isShipping:
          type: boolean
        isForwardRegistered:
          type: boolean
        shipmentStatus:
          type:
          - string
          - 'null'
        shipmentNumber:
          type:
          - string
          - 'null'
        interimReceipt:
          type:
          - string
          - 'null'
        houseBill:
          type:
          - string
          - 'null'
        cfsReference:
          type:
          - string
          - 'null'
        shipmentType:
          type:
          - string
          - 'null'
        goodsDescription:
          type:
          - string
          - 'null'
        releaseType:
          type:
          - string
          - 'null'
        aviationSecurity:
          type:
          - string
          - 'null'
        originCode:
          type:
          - string
          - 'null'
        originCountry:
          type:
          - string
          - 'null'
        originPort:
          type:
          - string
          - 'null'
        etd:
          type:
          - string
          - 'null'
          format: date-time
        destinationCode:
          type:
          - string
          - 'null'
        destinationCountry:
          type:
          - string
          - 'null'
        destinationPort:
          type:
          - string
          - 'null'
        eta:
          type:
          - string
          - 'null'
          format: date-time
        serviceLevel:
          type:
          - string
          - 'null'
        incoterm:
          type:
          - string
          - 'null'
        additionalTerms:
          type:
          - string
          - 'null'
        transportMode:
          type:
          - string
          - 'null'
        containerMode:
          type:
          - string
          - 'null'
        shippedOnBoard:
  

# --- truncated at 32 KB (103 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/dsv/refs/heads/main/openapi/dsv-orders-api-openapi.yml