ShipStation V1 API — Customers

naftiko: 1.0.0-alpha2
info:
  label: ShipStation V1 API — Customers
  description: 'ShipStation V1 API — Customers. 3 operations. Lead operation: List Customers. Self-contained Naftiko capability
    covering one Shipstation business surface.'
  tags:
  - Shipstation
  - Customers
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHIPSTATION_API_KEY: SHIPSTATION_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-customers
    baseUri: https://ssapi.shipstation.com
    description: ShipStation V1 API — Customers business capability. Self-contained, no shared references.
    resources:
    - name: customers
      path: /customers
      operations:
      - name: listcustomers
        method: GET
        description: List Customers
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: stateCode
          in: query
          type: string
        - name: countryCode
          in: query
          type: string
        - name: marketplaceId
          in: query
          type: integer
        - name: tagId
          in: query
          type: integer
        - name: sortBy
          in: query
          type: string
        - name: sortDir
          in: query
          type: string
        - name: page
          in: query
          type: integer
        - name: pageSize
          in: query
          type: integer
    - name: customers-customerId
      path: /customers/{customerId}
      operations:
      - name: getcustomer
        method: GET
        description: Get Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customerId
          in: path
          type: integer
          required: true
      - name: updatecustomer
        method: PUT
        description: Update Customer
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: customerId
          in: path
          type: integer
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: basic
      username: '{{env.SHIPSTATION_USER}}'
      password: '{{env.SHIPSTATION_PASS}}'
  exposes:
  - type: rest
    namespace: v1-customers-rest
    port: 8080
    description: REST adapter for ShipStation V1 API — Customers. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/customers
      name: customers
      description: REST surface for customers.
      operations:
      - method: GET
        name: listcustomers
        description: List Customers
        call: v1-customers.listcustomers
        with:
          stateCode: rest.stateCode
          countryCode: rest.countryCode
          marketplaceId: rest.marketplaceId
          tagId: rest.tagId
          sortBy: rest.sortBy
          sortDir: rest.sortDir
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/customers/{customerid}
      name: customers-customerid
      description: REST surface for customers-customerId.
      operations:
      - method: GET
        name: getcustomer
        description: Get Customer
        call: v1-customers.getcustomer
        with:
          customerId: rest.customerId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updatecustomer
        description: Update Customer
        call: v1-customers.updatecustomer
        with:
          customerId: rest.customerId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-customers-mcp
    port: 9090
    transport: http
    description: MCP adapter for ShipStation V1 API — Customers. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-customers
      description: List Customers
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-customers.listcustomers
      with:
        stateCode: tools.stateCode
        countryCode: tools.countryCode
        marketplaceId: tools.marketplaceId
        tagId: tools.tagId
        sortBy: tools.sortBy
        sortDir: tools.sortDir
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: get-customer
      description: Get Customer
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-customers.getcustomer
      with:
        customerId: tools.customerId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-customer
      description: Update Customer
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-customers.updatecustomer
      with:
        customerId: tools.customerId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.