Blackbaud Orders API

openapi: 3.2.0
info:
  title: 'Blackbaud SKY API: Altru Sales Orders API'
  description: Altru Sales SKY API
  version: '1.0'
  x-apievangelist-provenance:
    source: https://developer.sky.blackbaud.com/developer/apis/alt-slsmg
    method: assembled from Blackbaud's public API Management developer data API (operations, parameters, representations, examples, stored definitions); nothing authored
    assembled: '2026-10-14'
servers:
- url: https://api.sky.blackbaud.com/alt-slsmg
security:
- Bb-Api-Subscription-Key: []
  OAuth2: []
tags:
- name: Orders
paths:
  /orders:
    post:
      operationId: CreateSalesOrderNote
      summary: Create a sales order note
      description: This operation is used to add a sales order note.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewSalesOrderNote'
            example:
              sales_order_id: ''
              context_type: 0
              title: ''
              date_entered: ''
              author_id: ''
              notetype: ''
              text_note: ''
              html_note: ''
              order_id: ''
              sales_order_item: ''
        description: ConfigurationMessage object representing operation intended to be created
      responses:
        '200':
          description: Returned when the operation successfully creates the resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostResponse'
        '400':
          description: Returned when the request body is not in the appropriate format.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Returned when the user does not have permission to create the resource.
        '404':
          description: Returned when the specified resource is not found.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      tags:
      - Orders
  /orders/{sales_order_id}:
    patch:
      operationId: EditOrderDeliveryInformation
      summary: Edit an order delivery information
      description: Edit the delivery/shipping inoperationation on an order
      parameters:
      - name: sales_order_id
        in: path
        required: true
        schema:
          type: string
        description: The sales order id.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EditOrderDeliveryInformation'
            example:
              recipient_id: ''
              address: ''
              phone: ''
              email_address: ''
              address_required: false
              phone_required: false
              email_required: false
        description: ConfigurationMessage object representing operation intended to be created
      responses:
        '200':
          description: Returned when the operation successfully edits the resource.
        '400':
          description: Returned when the request body is not in the appropriate format.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Returned when the user does not have permission to edit the resource.
        '404':
          description: Returned when the specified resource is not found.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      tags:
      - Orders
    get:
      operationId: GetOrderDeliveryInformation
      summary: Get an order delivery information
      description: Edit the delivery/shipping inoperationation on an order
      parameters:
      - name: sales_order_id
        in: path
        required: true
        schema:
          type: string
        description: The sales order id.
      responses:
        '200':
          description: Returned when the operation succeeds. The response body contains the specified resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderDeliveryInformation'
        '400':
          description: Returned when the request body is not in the appropriate format.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
        '403':
          description: Returned when the user does not have permission to get the resource.
        '404':
          description: Returned when the specified resource is not found.
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ProblemDetails'
      tags:
      - Orders
  /orders/{sales_order_id}/view:
    get:
      operationId: ViewOrderPatron
      summary: View an order patron
      description: Provides inoperationation about a patron that is linked to an order.
      parameters:
      - name: sales_order_id
        in: path
        required: true
        schema:
          type: string
        description: The sales order id.
      responses:
        '200':
          description: Returned when the operation succeeds. The response body contains the specified resource.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderPatronView'
      tags:
      - Orders
components:
  schemas:
    NewSalesOrderNote:
      required:
      - sales_order_id
      - date_entered
      - notetype
      type: object
      properties:
        sales_order_id:
          type: string
          description: The sales order ID.
        context_type:
          type: integer
          description: The context type. Read-only in the SOAP API.
          format: int32
        title:
          maxLength: 50
          minLength: 0
          type: string
          description: The the title of this note.
        date_entered:
          type: string
          description: 'The the date this note was entered. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.'
          format: date-time
        author_id:
          type: string
          description: The the author of this note.
        notetype:
          type: string
          description: The the user-defined type of this note. This code table can be queried at https://api.sky.blackbaud.com/alt-adnmg/codetables/salesordernotetypecode/entries
        text_note:
          type: string
          description: The the text that comprises this note.
        html_note:
          type: string
          description: The the html that comprises this note.
        order_id:
          type: string
          description: The order ID. Read-only in the SOAP API.
        sales_order_item:
          type: string
          description: The sales order item with which the note refers. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/62358363-7019-41d0-92f5-8e28718e8eef?parameters=sales_order_id,{order_id}.
      additionalProperties: false
      description: CreateSalesOrderNote
      example:
        sales_order_id: ''
        context_type: 0
        title: ''
        date_entered: ''
        author_id: ''
        notetype: ''
        text_note: ''
        html_note: ''
        order_id: ''
        sales_order_item: ''
      x-display-name: Sales Order Note Add Form
      x-display-id: Sales Order Note Add Form
    OrderDeliveryInformation:
      required:
      - recipient_id
      type: object
      properties:
        recipient_id:
          type: string
          description: The recipient.
        address:
          type: string
          description: The address. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/760e375f-c716-4d37-a49f-ff4ec26d5420?parameters=constituent_id,{recipient_id}.
        phone:
          type: string
          description: The phone number. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/74f10304-2813-4c07-a1e6-d205fb89a865?parameters=constituent_id,{recipient_id}.
        email_address:
          type: string
          description: The email address. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/1b855f0b-e51e-49d9-9421-9b972dba2f28?parameters=constituent_id,{recipient_id}.
        address_required:
          type: boolean
          description: Indicates whether address required. Read-only in the SOAP API.
        phone_required:
          type: boolean
          description: Indicates whether phone required. Read-only in the SOAP API.
        email_required:
          type: boolean
          description: Indicates whether email required. Read-only in the SOAP API.
      additionalProperties: false
      description: GetOrderDeliveryInformation
      x-display-name: Order Delivery Information Edit Data Form
      x-display-id: Order Delivery Information Edit Data Form
    ProblemDetails:
      type: object
      properties:
        type:
          type: string
          description: A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".
        title:
          type: string
          description: A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).
        status:
          type: integer
          description: The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.
          format: int32
        detail:
          type: string
          description: A human-readable explanation specific to this occurrence of the problem.
        instance:
          type: string
          description: A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
        trace_id:
          type: string
          description: A request ID that can be provided to Blackbaud Support that may help with further troubleshooting.
        span_id:
          type: string
          description: A request ID that can be provided to Blackbaud Support that may help with further troubleshooting.
      additionalProperties: false
      description: A machine-readable format for specifying errors in HTTP API responses based on https://tools.ietf.org/html/rfc7807.
      x-display-name: Problem details
      x-display-id: ProblemDetails
    DateWithTimeOffSet:
      type: object
      properties:
        date_time:
          type: string
          description: The date time.
          format: datetime
        offset_minutes:
          type: integer
          description: The offset minutes.
          format: int32
      description: DateWithTimeOffSet
      x-display-name: DateTime OffsetMinutes
      x-display-id: DateTime OffsetMinutes
    OrderPatronView:
      type: object
      properties:
        constituent_id:
          type: string
          description: The constituentid.
        address:
          maxLength: 300
          minLength: 0
          type: string
          description: The address.
        phone_number:
          maxLength: 100
          minLength: 0
          type: string
          description: The phonenumber.
        email_address:
          maxLength: 100
          minLength: 0
          type: string
          description: The emailaddress.
        recognition_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The recognitionconstituencytext.
        member_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The memberconstituencytext.
        board_member_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The boardmemberconstituencytext.
        relation_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The relationconstituencytext.
        staff_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The staffconstituencytext.
        donor_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The donorconstituencytext.
        fundraiser_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The fundraiserconstituencytext.
        prospect_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The prospectconstituencytext.
        volunteer_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The volunteerconstituencytext.
        community_member_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The communitymemberconstituencytext.
        user_defined_constituency_text:
          maxLength: 4000
          minLength: 0
          type: string
          description: The userdefinedconstituencytext.
        alumnus_status_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The alumnusstatustext.
        registrant_status_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The registrantstatustext.
        vendor_status_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The vendorstatustext.
        matchfinder_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The matchfinderconstituencytext.
        matchfinder_online_record_id:
          type: integer
          description: The matchfinderonlinerecordid.
          format: int32
        memberships:
          type: array
          items:
            $ref: '#/components/schemas/OrderPatronMemberships'
          description: Memberships.
        associated:
          type: boolean
          description: Indicates whether isassociated.
        not_associated:
          type: boolean
          description: Indicates whether notassociated.
        does_not_exist:
          type: boolean
          description: Indicates whether doesnotexist.
        info_exists:
          type: boolean
          description: Indicates whether infoexists.
        constituent_name:
          maxLength: 40
          minLength: 0
          type: string
          description: The constituentname.
        order_number:
          type: integer
          description: 'The order #.'
          format: int32
        order_date:
          $ref: '#/components/schemas/DateWithTimeOffSet'
        post_status:
          maxLength: 50
          minLength: 0
          type: string
          description: The post status.
        post_date:
          type: string
          description: 'The post date. Uses the format YYYY-MM-DDThh:mm:ss. An example date: <i>1955-11-05T22:04:00</i>.'
          format: date-time
        order_total:
          type: number
          description: The total.
          format: double
        amount_paid:
          type: number
          description: The amount paid.
          format: double
        balance:
          type: number
          description: The balance.
          format: double
        amount_refunded:
          type: number
          description: The amount refunded.
          format: double
        refund_id:
          type: string
          description: The refundid.
        user_name:
          maxLength: 100
          minLength: 0
          type: string
          description: The created by.
        sales_method_type:
          maxLength: 50
          minLength: 0
          type: string
          description: The sales method.
        order_status:
          type: integer
          description: The status.
          format: int32
        receiptoption:
          maxLength: 50
          minLength: 0
          type: string
          description: The receipt option.
        salesorderemailaddress:
          maxLength: 100
          minLength: 0
          type: string
          description: The email.
        delivery_method:
          maxLength: 100
          minLength: 0
          type: string
          description: The method.
        recipient:
          maxLength: 154
          minLength: 0
          type: string
          description: The recipient.
        delivery_address:
          maxLength: 300
          minLength: 0
          type: string
          description: The address.
        delivery_phone:
          maxLength: 100
          minLength: 0
          type: string
          description: The phone.
        delivery_email:
          maxLength: 100
          minLength: 0
          type: string
          description: The email.
        order_status_text:
          maxLength: 50
          minLength: 0
          type: string
          description: The order status.
        bank_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The bankconstituencytext.
        patron_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The patronconstituencytext.
        same_as_patron:
          type: boolean
          description: Indicates whether same as patron.
        address_required:
          type: boolean
          description: Indicates whether addressrequired. Read-only in the SOAP API.
        phone_required:
          type: boolean
          description: Indicates whether phonerequired. Read-only in the SOAP API.
        email_required:
          type: boolean
          description: Indicates whether emailrequired. Read-only in the SOAP API.
        recipient_associated:
          type: boolean
          description: Indicates whether recipientassociated. Read-only in the SOAP API.
        sales_method_type_code:
          type: integer
          description: The salesmethodtypecode.
          format: int32
        loyal_donor_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The loyaldonorconstituencytext.
        major_donor_constituency_text:
          maxLength: 100
          minLength: 0
          type: string
          description: The majordonorconstituencytext.
        overage_kept:
          type: number
          description: The overage kept.
          format: double
        tax_exempt:
          type: boolean
          description: Indicates whether istaxexempt.
        tax_exempt_reason:
          maxLength: 100
          minLength: 0
          type: string
          description: The reason.
        tax_exempt_comments:
          maxLength: 255
          minLength: 0
          type: string
          description: The comments.
      additionalProperties: false
      description: ViewOrderPatron
      x-display-name: Order Patron View
      x-display-id: Order Patron View
    OrderPatronMemberships:
      type: object
      properties:
        membership_id:
          type: string
          description: membershipid
        membership_program_name:
          type: string
          description: membershipprogramname
        membership_level_name:
          type: string
          description: membershiplevelname
        membership_expiration:
          type: string
          description: membershipexpiration
          format: date
        in_renewal_window:
          type: boolean
          description: inrenewalwindow
        lapsed:
          type: boolean
          description: islapsed
        cancelled:
          type: boolean
          description: iscancelled
        pending:
          type: boolean
          description: ispending
      description: OrderPatronMemberships
      x-display-name: memberships
      x-display-id: memberships
    EditOrderDeliveryInformation:
      type: object
      properties:
        recipient_id:
          type: string
          description: The recipient.
        address:
          type: string
          description: The address. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/760e375f-c716-4d37-a49f-ff4ec26d5420?parameters=constituent_id,{recipient_id}.
        phone:
          type: string
          description: The phone number. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/74f10304-2813-4c07-a1e6-d205fb89a865?parameters=constituent_id,{recipient_id}.
        email_address:
          type: string
          description: The email address. This simple list can be queried at https://api.sky.blackbaud.com/alt-adnmg/simplelists/1b855f0b-e51e-49d9-9421-9b972dba2f28?parameters=constituent_id,{recipient_id}.
        address_required:
          type: boolean
          description: Indicates whether address required. Read-only in the SOAP API.
        phone_required:
          type: boolean
          description: Indicates whether phone required. Read-only in the SOAP API.
        email_required:
          type: boolean
          description: Indicates whether email required. Read-only in the SOAP API.
      additionalProperties: false
      description: EditOrderDeliveryInformation
      example:
        recipient_id: ''
        address: ''
        phone: ''
        email_address: ''
        address_required: false
        phone_required: false
        email_required: false
      x-display-name: Order Delivery Information Edit Data Form
      x-display-id: Order Delivery Information Edit Data Form
    PostResponse:
      type: object
      properties:
        id:
          type: string
          description: The newly created ID.
      additionalProperties: false
      description: Defines the shape of a post response object.
  securitySchemes:
    Bb-Api-Subscription-Key:
      type: apiKey
      name: Bb-Api-Subscription-Key
      in: header
    OAuth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.blackbaud.com/oauth/authorize
          tokenUrl: https://oauth2.sky.blackbaud.com/token
          scopes: {}