ShipEngine Account API

For additional information about the ShipEngine account.

GitHub OpenAPI

Operations 6

GET /v1/account/settings List account settings #
GET /v1/account/settings/images List account images #
POST /v1/account/settings/images Create an account image #
GET /v1/account/settings/images/{label_image_id} Get account image by ID #
PUT /v1/account/settings/images/{label_image_id} Update account image by ID #
DELETE /v1/account/settings/images/{label_image_id} Delete account image by ID #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/shipengine:shipengine-account-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

shipengine-account-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Shipengine Account API
  version: 1.1.202604070904
  contact:
    name: ShipEngine Sales & Support
    email: sales@shipengine.com
    url: https://www.shipengine.com/contact/
    x-phone: 1-512-856-5379
  license:
    name: Proprietary
    url: https://www.shipengine.com/terms-of-service/
  termsOfService: https://www.shipengine.com/terms-of-service/
  x-logo:
    url: https://shipengine.github.io/img/shipengine-logo-square.png
    backgroundColor: '#FFFFFF'
    altText: ShipEngine logo
  description: 'Operations tagged account across 2 of this provider''s published API definitions: shipengine-openapi-docs-bundle.yaml, shipengine-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.shipengine.com
security:
- api_key: []
tags:
- name: Account
  description: For additional information about the ShipEngine account.
  x-displayName: Account
paths:
  /v1/account/settings:
    summary: Account settings
    description: ShipEngine Account settings
    get:
      summary: List account settings
      description: List all account settings for the ShipEngine account
      tags:
      - Account
      operationId: list_account_settings
      responses:
        '200':
          description: The request was a success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_account_settings_response_body'
        '400':
          $ref: '#/components/responses/400_error_response'
        '404':
          $ref: '#/components/responses/404_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
    servers:
    - url: https://api.shipengine.com
  /v1/account/settings/images:
    summary: Account settings images
    description: ShipEngine Account images
    get:
      summary: List account images
      description: List all account images for the ShipEngine account
      tags:
      - Account
      operationId: list_account_images
      responses:
        '200':
          description: The request was a success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list_account_settings_images_response_body'
        '400':
          $ref: '#/components/responses/400_error_response'
        '404':
          $ref: '#/components/responses/404_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
    post:
      summary: Create an account image
      description: Create an Account Image
      tags:
      - Account
      operationId: create_account_image
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_account_settings_image_request_body'
      responses:
        '200':
          description: The requested object creation was a success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_account_settings_images_response_body'
        '400':
          $ref: '#/components/responses/400_error_response'
        '404':
          $ref: '#/components/responses/404_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
    servers:
    - url: https://api.shipengine.com
  /v1/account/settings/images/{label_image_id}:
    summary: Account settings images
    description: ShipEngine Account images
    get:
      summary: Get account image by ID
      description: Retrieve information for an account image.
      tags:
      - Account
      operationId: get_account_settings_images_by_id
      parameters:
      - name: label_image_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/image_id'
        description: Label Image Id
      responses:
        '200':
          description: The request was a success.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_account_settings_images_response_body'
        '400':
          $ref: '#/components/responses/400_error_response'
        '404':
          $ref: '#/components/responses/404_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
    put:
      summary: Update account image by ID
      description: Update information for an account image.
      tags:
      - Account
      operationId: update_account_settings_images_by_id
      parameters:
      - name: label_image_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/image_id'
        description: Label Image Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_account_settings_image_request_body'
      responses:
        '204':
          description: The request was successful.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/empty_response_body'
            application/json:
              schema:
                $ref: '#/components/schemas/empty_response_body'
        '400':
          $ref: '#/components/responses/400_error_response'
        '404':
          $ref: '#/components/responses/404_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
    delete:
      summary: Delete account image by ID
      description: Delete Account Image By Id
      tags:
      - Account
      operationId: delete_account_image_by_id
      parameters:
      - name: label_image_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/image_id'
        description: Label Image Id
      responses:
        '204':
          description: The request was successful.
          content:
            text/plain:
              schema:
                $ref: '#/components/schemas/empty_response_body'
            application/json:
              schema:
                $ref: '#/components/schemas/empty_response_body'
        '400':
          $ref: '#/components/responses/400_error_response'
        '404':
          $ref: '#/components/responses/404_error_response'
        '500':
          $ref: '#/components/responses/500_error_response'
    servers:
    - url: https://api.shipengine.com
components:
  schemas:
    error_response_body:
      title: error_response_body
      type: object
      description: An error response body
      required:
      - request_id
      - errors
      additionalProperties: false
      properties:
        request_id:
          allOf:
          - $ref: '#/components/schemas/uuid'
          description: 'A UUID that uniquely identifies the request id.

            This can be given to the support team to help debug non-trivial issues that may occur

            '
        errors:
          type: array
          readOnly: true
          items:
            $ref: '#/components/schemas/error'
          description: The errors associated with the failed API call
    se_id:
      title: se_id
      type: string
      minLength: 1
      maxLength: 25
      pattern: ^se(-[a-z0-9]+)+$
      example: se-28529731
      description: A string that uniquely identifies a ShipEngine resource, such as a carrier, label, shipment, etc.
    error_source:
      title: error_source
      type: string
      example: shipengine
      enum:
      - carrier
      - order_source
      - shipengine
      description: 'The source of the error, as indicated by the name this informs us if the API call failed because of the

        carrier, the order source, or the ShipEngine API itself.

        '
    default_label_layout:
      title: default_label_layout
      type: string
      example: 4x6
      enum:
      - 4x6
      - Letter
      description: The possible default label layout values
    error_code:
      title: error_code
      type: string
      example: invalid_field_value
      enum:
      - auto_fund_not_supported
      - batch_cannot_be_modified
      - bring_your_own_label_not_supported
      - carrier_conflict
      - carrier_disconnected
      - carrier_not_connected
      - carrier_not_supported
      - confirmation_not_supported
      - default_warehouse_cannot_be_deleted
      - field_conflict
      - field_value_required
      - forbidden
      - identifier_conflict
      - identifiers_must_match
      - insufficient_funds
      - invalid_address
      - invalid_billing_plan
      - invalid_field_value
      - invalid_identifier
      - invalid_status
      - invalid_string_length
      - label_images_not_supported
      - meter_failure
      - multiple_sales_orders
      - order_source_not_active
      - rate_limit_exceeded
      - refresh_not_supported
      - request_body_required
      - return_label_not_supported
      - sales_order_link_required
      - settings_not_supported
      - subscription_inactive
      - terms_not_accepted
      - tracking_not_supported
      - trial_expired
      - unauthorized
      - unknown
      - unspecified
      - verification_failure
      - warehouse_conflict
      - webhook_event_type_conflict
      - customs_items_required
      - incompatible_paired_labels
      - invalid_charge_event
      - invalid_object
      - no_rates_returned
      - file_not_found
      - shipping_rule_not_found
      - service_not_determined
      - funding_source_registration_in_progress
      - insurance_failure
      - funding_source_missing_configuration
      - funding_source_error
      - freight_connection_inactive
      - freight_provider_id_required
      - freight_provider_already_connected
      - freight_shipment_not_found
      - freight_tracking_not_available
      - freight_tracking_not_found
      - freight_shipment_not_batchable
      description: The error code specified for the failed API Call
    carrier_code:
      title: carrier_code
      type: string
      pattern: ^[a-z0-9]+(_[a-z0-9]+)*$
      example: dhl_express
      description: 'A shipping carrier, such as `fedex`, `dhl_express`, `stamps_com`, etc.

        '
    uuid:
      title: uuid
      type: string
      format: uuid
      minLength: 36
      maxLength: 36
      pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
      example: aa3d8e8e-462b-4476-9618-72db7f7b7009
      description: A UUID (a.k.a. GUID) that uniquely identifies a resource
    error:
      title: error
      type: object
      description: 'The error structure that gets returned with almost all failed API calls

        '
      required:
      - error_source
      - error_type
      - error_code
      - message
      additionalProperties: false
      properties:
        error_source:
          $ref: '#/components/schemas/error_source'
        error_type:
          $ref: '#/components/schemas/error_type'
        error_code:
          $ref: '#/components/schemas/error_code'
        message:
          type: string
          readOnly: true
          example: Body of request cannot be null.
          minLength: 1
          description: An error message associated with the failed API call
        carrier_id:
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/se_id'
          description: A string that uniquely identifies the carrier that generated the error.
        carrier_code:
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/carrier_code'
          description: 'The name of the shipping carrier that generated the error, such as `fedex`, `dhl_express`, `stamps_com`, etc.

            '
        field_name:
          type: string
          readOnly: true
          example: shipment.ship_to.phone_number
          description: The name of the field that caused the error
    paged_list_response_body:
      title: paged_list_response_body
      type: object
      required:
      - total
      - page
      - pages
      - links
      additionalProperties: true
      properties:
        total:
          type: integer
          minimum: 0
          example: 2750
          description: The total number of items across all pages of results
        page:
          type: integer
          minimum: 1
          example: 1
          description: The current page number of results.  For example, if there are 80 results, and the page size is 25, then `page` could be 1, 2, 3, or 4.  The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.
        pages:
          type: integer
          minimum: 0
          example: 4
          description: The total number of pages of results.  For example, if there are 80 results, and the page size is 25, then `pages` would be 4.  The first three pages would contain 25 items each, and the fourth page would contain the five remaining items.  If there are no results, then `pages` will be zero.
        links:
          $ref: '#/components/schemas/pagination_link'
      description: 'Many ShipEngine endpoints return a paged list of items.  In addition to the returned items, these responses also include information about the total number of items, the number of pages of results, and URLs of other pages of results.

        '
    account_settings:
      title: account_settings
      type: object
      description: A ShipEngine account settings response body
      additionalProperties: false
      properties:
        default_label_layout:
          $ref: '#/components/schemas/default_label_layout'
    get_account_settings_response_body:
      title: get_account_settings_response_body
      allOf:
      - $ref: '#/components/schemas/list_account_settings_body'
    list_account_settings_images_response_body:
      title: list_account_settings_images_response_body
      allOf:
      - $ref: '#/components/schemas/list_account_images_response_body'
    url:
      title: url
      type: string
      format: url
      minLength: 1
      example: https://example.com/resource
      description: A URL
    image_id:
      title: image_id
      type: string
      minLength: 4
      example: img_DtBXupDBxREpHnwEXhTfgK
      description: Used to identify an image resource.
    date_time:
      title: date_time
      type: string
      format: date-time
      pattern: ^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}(\.\d+)?(Z|[-+]\d{2}:\d{2})$
      example: '2018-09-23T15:00:00.000Z'
      description: 'An [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) string that represents a date and time.

        '
    pagination_link:
      title: pagination_link
      type: object
      description: Helpful links to other pages of results
      required:
      - first
      - last
      - prev
      - next
      additionalProperties: false
      properties:
        first:
          allOf:
          - $ref: '#/components/schemas/link'
          description: 'The link to the first page of results.  This object will _always_ have an `href` field. If there are no results, then the first page will contain an empty array of items.

            '
        last:
          allOf:
          - $ref: '#/components/schemas/link'
          description: 'The link to the final page of results.  This object will _always_ have an `href` field. If there are no results, then the final page will contain an empty array of items.

            '
        prev:
          allOf:
          - $ref: '#/components/schemas/optional_link'
          description: 'The link to the previous page of results.  The `href` field will only be set when the `page` is 2 or greater.

            '
        next:
          allOf:
          - $ref: '#/components/schemas/optional_link'
          description: 'The link to the next page of results.  The `href` field will only be set when the `page` is less than `pages`.

            '
    create_account_settings_image_request_body:
      title: create_account_settings_image_request_body
      description: A ShipEngine account settings images request body
      required:
      - name
      - image_content_type
      - image_data
      additionalProperties: false
      allOf:
      - $ref: '#/components/schemas/account_settings_images'
    error_type:
      title: error_type
      type: string
      example: validation
      enum:
      - account_status
      - business_rules
      - validation
      - security
      - system
      - integrations
      - funding_sources
      description: 'The type of error

        '
    optional_link:
      title: optional_link
      description: A link to a related resource, or an empty object if there is no resource to link to
      properties:
        href:
          allOf:
          - $ref: '#/components/schemas/url'
          description: The URL of the linked resource, if any
        type:
          type: string
          minLength: 1
          description: The type of resource, or the type of relationship to the parent resource
    get_account_settings_images_response_body:
      title: get_account_settings_images_response_body
      description: A get account images by id response body
      additionalProperties: false
      allOf:
      - $ref: '#/components/schemas/account_settings_images'
    account_settings_images:
      title: account_settings_images
      description: A ShipEngine account images body
      additionalProperties: false
      properties:
        label_image_id:
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/image_id'
          description: 'A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.

            '
        name:
          type: string
          minLength: 1
          maxLength: 50
          example: My logo
          description: 'A human readable name for the image.

            '
        is_default:
          type: boolean
          example: false
          description: 'Indicates whether this image is set as default.

            '
        image_content_type:
          allOf:
          - type: string
            enum:
            - image/png
            - image/jpeg
            description: The image type
          description: 'The file type of the image.

            '
        image_data:
          type: string
          example: iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==
          description: 'A base64 encoded string representation of the image.

            '
        created_at:
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/date_time'
          description: The date and time that the image was created in ShipEngine.
        modified_at:
          readOnly: true
          allOf:
          - $ref: '#/components/schemas/date_time'
          description: The date and time that the image was modified in ShipEngine.
    update_account_settings_image_request_body:
      title: update_account_settings_image_request_body
      description: A ShipEngine account settings images request body
      required:
      - is_default
      additionalProperties: false
      allOf:
      - $ref: '#/components/schemas/account_settings_images'
    empty_response_body:
      title: empty_response_body
      type: string
      minLength: 0
      maxLength: 0
    list_account_images_response_body:
      title: list_account_images_response_body
      description: A list account images response body
      required:
      - images
      additionalProperties: false
      properties:
        images:
          type: array
          readOnly: true
          minItems: 0
          items:
            allOf:
            - title: account_settings_images
              type: object
              description: A ShipEngine account images body
              additionalProperties: false
              properties:
                label_image_id:
                  readOnly: true
                  allOf:
                  - $ref: '#/components/schemas/image_id'
                  description: 'A string that uniquely identifies the image. This ID is generated by ShipEngine when the image is uploaded.

                    '
                name:
                  type: string
                  minLength: 1
                  maxLength: 50
                  example: My logo
                  description: 'A human readable name for the image.

                    '
                is_default:
                  type: boolean
                  example: false
                  description: 'Indicates whether this image is set as default.

                    '
                image_content_type:
                  allOf:
                  - type: string
                    enum:
                    - image/png
                    - image/jpeg
                    description: The image type
                  description: 'The file type of the image.

                    '
                image_data:
                  type: string
                  example: iVBORw0KGgoAAAANSUhEUgAAABkAAAAZCAYAAADE6YVjAAAAAXNSR0IArs4c6QAAAiVJREFUSEu91j3IeVEcB/CvSTIoBrFSikEZMdjsjExeUspgUEp5SUpeshrIgEFJJmWwMZHJQGHDhJSXTPfpnH/8ebzd56HnN93u7ZzP/f1+55x7Ob1ejxEKheByufh0HI9HrFYrcKbTKUMu5HI5BALBx5zNZoPxeAySAGc2mzF8Pp/e+BR0Ash8u93uHyKVSnH54J2Mvs8zn8//I6RO70L3xt8g70CPXvAu8hvoWQUeIj+BXpX4KcIGegWQOV4izyA2AGvkHsQW+BFyCUkkEiwWC9Ybl1W5Ls8ZMoAABCIbmE3cINFoFMFgEEajEeVyGSKRCJ1OB3q9ns5nMpmQTCaxXq9/l8loNEKj0YDX66UACYvFQq9brRYcDgdUKhU9RD/SEwLm83lEIhGUSiX0+33E4/GrU5otRMs1mUyYbDYLu90OhUJBMzhlZbPZ4Pf7odFo4HQ6b1rABqJIvV5nttstLc0pSIn2+z0tTy6XQ6FQoI/a7TZ0Ot0V9gqiiMFgYKrVKm0yieVyCZ/PB6vVSpF0Ok2zJHEqIY/HYw1RxOfzMYlE4jwoEAhAJpPBbDZf9eBwOCCVSsHtdp9f6FJ6egorlUqmVqvRfjSbTXS7XXg8nptP8Svk0RF01ROtVguSUTgchlgsPpeOZBaLxTAcDlEsFpHJZPC9XM8yoshgMGBCoRBdQWTCU7hcLjohWb5kM6rValQqlfMKfLbbb77xf/K38hf/XV9ilOpnLqvnogAAAABJRU5ErkJggg==
                  description: 'A base64 encoded string representation of the image.

                    '
                created_at:
                  readOnly: true
                  allOf:
                  - $ref: '#/components/schemas/date_time'
                  description: The date and time that the image was created in ShipEngine.
                modified_at:
                  readOnly: true
                  allOf:
                  - $ref: '#/components/schemas/date_time'
                  description: The date and time that the image was modified in ShipEngine.
            description: Image
          description: Image List
      allOf:
      - $ref: '#/components/schemas/paged_list_response_body'
    list_account_settings_body:
      title: list_account_settings_body
      description: An account settings list response body
      additionalProperties: false
      allOf:
      - $ref: '#/components/schemas/account_settings'
    link:
      title: link
      description: A link to a related resource
      required:
      - href
      allOf:
      - $ref: '#/components/schemas/optional_link'
  responses:
    404_error_response:
      description: The specified resource does not exist.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response_body'
    400_error_response:
      description: The request contained errors.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response_body'
    500_error_response:
      description: 'An error occurred on ShipStation API''s side.


        > This error will automatically be reported to our engineers.

        '
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/error_response_body'
  securitySchemes:
    api_key:
      type: apiKey
      name: API-Key
      in: header
      description: 'To authenticate yourself to ShipEngine, you need to include an `API-Key` header in each API call. If you don''t include a key when making an API request, or if you use an incorrect or expired key, then ShipEngine will respond with a `401 Unauthorized` error.

        Learn more about API keys in our [authentication guide](https://docs.shipstation.com/apis/shipengine/docs/guides/auth).

        '
x-refined-from:
- shipengine-openapi-docs-bundle.yaml
- shipengine-openapi.yml
x-provenance:
  method: harvested
  publisher: ShipEngine
  source: https://raw.githubusercontent.com/ShipEngine/shipengine-openapi/master/openapi.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)