Digi-Key Customer Resource API

openapi: 3.2.0
info:
  title: Digi Key Customer Resource API
  version: v1
  contact:
    name: API Support
    url: https://developer.digikey.com/support
  termsOfService: https://www.digikey.com/en/terms-and-conditions
  description: 'Operations tagged CustomerResource across 2 of this provider''s published API definitions: digi-key-customerresource-customerresource-v1.json, digi-key-customerresource-customerresource-v1-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.digikey.com/CustomerResource/v1
security:
- apiKeySecurity: []
  oauth2ApplicationSecurity: []
tags:
- name: CustomerResource
paths:
  /associatedaccounts:
    get:
      tags:
      - CustomerResource
      summary: Look up Account IDs that are associated with your CustomerID
      operationId: AssociatedAccounts
      parameters:
      - in: header
        name: Authorization
        description: OAuth Bearer Token. Please see<a href= "https://developer.digikey.com/documentation/oauth" target= "_blank" > OAuth 2.0 Documentation </a > page for more info.
        schema:
          type: string
      - in: header
        name: X-DIGIKEY-Client-Id
        description: The Client Id for your app.
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AccountAssociationResponse'
        '400':
          description: Bad Request - The input model is invalid or malformed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '401':
          description: Unauthorized - Token is expired or Client Id or subscription are invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '403':
          description: The target resource is forbidden.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '404':
          description: Not Found - The requested resource could not be found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '429':
          description: Too Many Requests - Your rate limit has been exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '500':
          description: An unhandled error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
        '503':
          description: Service Unavailable - The service is temporarily unavailable
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DKProblemDetails'
    servers:
    - url: https://api.digikey.com/CustomerResource/v1
components:
  schemas:
    AccountAddress:
      description: Address for account
      type: object
      properties:
        CompanyName:
          description: Company name on address
          type: string
          example: Corporation X
        AddressLine1:
          description: First address line
          type: string
          example: 123 North Street
        AddressLine2:
          description: Second address line
          type: string
          example: 123 North Street
        AddressLine3:
          description: Third address line
          type: string
          example: 123 North Street
        City:
          description: City on address
          type: string
          example: Metrocity
        State:
          description: State code on address
          type: string
          example: MN
        PostalCode:
          description: Postal code on address
          type: string
          example: '78303'
        CountryCode:
          description: Country on address
          type: string
          example: USA
      additionalProperties: false
    AccountInformation:
      description: Information on a particular account
      type: object
      properties:
        AccountId:
          format: int32
          description: Your DigiKey AccountID. You may need to populate this value in some search, quote, list, and account history API calls. It is also needed when placing an order. Select ‘My account’ above to learn more about AccountIDs.
          type: integer
        Address:
          $ref: '#/components/schemas/AccountAddress'
      additionalProperties: false
    DKProblemDetails:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          format: int32
          type: integer
        detail:
          type: string
        instance:
          type: string
        correlationId:
          type: string
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          readOnly: true
      additionalProperties: false
    AccountAssociationResponse:
      description: AccountAssociationResponse
      type: object
      properties:
        Accounts:
          description: List of accounts associated with your customer ID
          type: array
          items:
            $ref: '#/components/schemas/AccountInformation'
        EmailAddressUsed:
          description: Email address used to look up associated AccountIDs. This is the email address that you used for authentication.
          type: string
      additionalProperties: false
  securitySchemes:
    apiKeySecurity:
      type: apiKey
      name: X-DIGIKEY-Client-Id
      in: header
      description: Client Id for current application
    oauth2ApplicationSecurity:
      type: oauth2
      flows:
        clientCredentials:
          scopes: {}
          tokenUrl: https://api.digikey.com/v1/oauth2/token
x-refined-from:
- digi-key-customerresource-customerresource-v1.json
- digi-key-customerresource-customerresource-v1-openapi.yml
x-host-sandbox: sandbox-api.digikey.com
x-host-production: api.digikey.com
x-source-pages:
- https://developer.digikey.com/products/ordering/ordermanagement/salesorderbyid
- https://developer.digikey.com/products/ordering/ordermanagement/salesordersbyponumber
- https://developer.digikey.com/products/ordering/ordermanagement/changeeligibility
- https://developer.digikey.com/products/ordering/ordermanagement/nextavailabledeliverydate
- https://developer.digikey.com/products/ordering/ordermanagement/salesorderdetails
- https://developer.digikey.com/products/ordering/ordermanagement/salesorderdetailbyid
- https://developer.digikey.com/products/ordering/ordermanagement/salesorderschedules
- https://developer.digikey.com/products/ordering/ordermanagement/replaceschedule
- https://developer.digikey.com/products/ordering/ordermanagement/salesorderschedulebyid
- https://developer.digikey.com/products/ordering/ordermanagement/partialscheduleupdate