> ## Documentation Index
> Fetch the complete documentation index at: https://sendcloud.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve an integration

> Get a valid integration from the Sendcloud system



## OpenAPI

````yaml /.openapi/v3/integrations/openapi.yaml get /integrations/{id}
openapi: 3.1.0
info:
  title: Integrations
  version: 3.0.0
  contact:
    name: Sendcloud API Support
    email: contact@sendcloud.com
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  description: >-
    The Integrations API lets you manage some aspects of your integrations, and
    set and retrieve available shop order statuses.
servers:
  - url: https://panel.sendcloud.sc/api/v3
    description: Sendcloud Production
security: []
tags:
  - name: Integrations
    description: IntegrationsAPI
  - name: Exception logs
    description: Integration exception logs API
paths:
  /integrations/{id}:
    parameters:
      - schema:
          type: integer
          minimum: 1
        name: id
        in: path
        required: true
        description: Filtering on the Sendcloud integration ID
    get:
      tags:
        - Integrations
      summary: Retrieve an integration
      description: Get a valid integration from the Sendcloud system
      operationId: sc-public-v3-integrations-get-retrieve_integration
      responses:
        '200':
          description: Retrieved integration corresponding to the provided integration_id
          content:
            application/json:
              schema:
                title: Integration Get Response
                type: object
                description: >-
                  Integration object as represented in the response of the get
                  request.
                properties:
                  data:
                    $ref: '#/components/schemas/integration-response-model'
                    type: object
              examples:
                Response:
                  value:
                    data:
                      id: 23452345
                      shop_name: 'Integration #1'
                      shop_url: https://www.my-shop-integration.com/
                      type: api
                      started_failing_at: '2023-11-10T16:16:42Z'
                      last_fetched_at: '2023-11-10T16:15:09Z'
                      created_at: '2023-11-04T14:15:22Z'
                      updated_at: '2023-11-08T12:23:56Z'
                      service_point_enabled: true
                      service_point_carriers:
                        - ups
                        - dhl
                      webhook_active: true
                      webhook_url: >-
                        https://my-shop-integration.integrator/api/webhooks/sendcloud
                      feedback_type: eager
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/errors'
              examples:
                OrderDoesNotExist:
                  summary: Integration does not exist
                  value:
                    errors:
                      - status: 404
                        code: not_found
                        title: Not Found
                        detail: >-
                          The Integration could not be found with the search
                          criteria given
      security:
        - HTTPBasicAuth: []
components:
  schemas:
    integration-response-model:
      title: Integration Response Object
      type: object
      description: Integration object.
      allOf:
        - $ref: '#/components/schemas/integration-model'
        - type: object
          properties:
            id:
              type: integer
              description: ID of an integration.
              example: 23452345
            type:
              type: string
              description: >-
                Type of shop/system the integration connects to. In Integrations
                API V2, this attribute was referred to as `system`.
              example: api
            started_failing_at:
              type:
                - string
                - 'null'
              format: date-time
              description: >-
                Timestamp from when the integration is failing to fetch orders
                or to send feedback. This value will be in the [ISO8601
                format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).
                In the Integrations API V2, this attribute was referred to as
                `failing_since`.
              example: '2023-11-10T16:16:42Z'
            last_fetched_at:
              type:
                - string
                - 'null'
              format: date-time
              description: >-
                The last time we managed to fetch data from this integration,
                used for rate limiting purposes. This value will be in the
                [ISO8601
                format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).
                In the Integrations API V2, this attribute was referred to as
                `last_fetch`.
              example: '2023-11-10T16:15:09Z'
            created_at:
              type: string
              format: date-time
              description: >-
                Timestamp when the integration was created. This value will be
                in the [ISO8601
                format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).
              example: '2023-11-04T14:15:22Z'
            updated_at:
              type: string
              format: date-time
              description: >-
                Timestamp when the integration was last updated. This value will
                be in the [ISO8601
                format](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6).
              example: '2023-11-08T12:23:56Z'
    errors:
      title: Errors
      type: object
      description: A standardized format for errors in JSON:API responses.
      properties:
        errors:
          type:
            - array
            - object
          items:
            type: object
            allOf:
              - $ref: '#/components/schemas/ErrorObject'
            required:
              - status
              - code
              - detail
    integration-model:
      title: Integration Object
      type: object
      description: Integration object.
      properties:
        shop_name:
          type: string
          title: Shop Name
          maxLength: 250
          minLength: 1
          description: Name of the shop.
          example: My Shop Integration
        shop_url:
          type: string
          title: Shop url
          description: URL of the shop the integration connects to.
          format: uri
          minLength: 1
          example: https://www.my-shop-integration.com/
        service_point_enabled:
          type: boolean
          title: Service point enabled
          description: Flag indicating if delivery to service points is enabled.
          example: false
        service_point_carriers:
          type: array
          title: Service point carriers
          description: >-
            List of carriers available for the service point picker. If service
            point delivery is enabled, make sure to provide at least one
            carrier.
          items:
            type: string
            example: ups
          example:
            - ups
            - dhl
        webhook_active:
          type: boolean
          title: Webhook active
          description: Flag indicating if parcel updates should be sent via the webhook.
          example: false
        webhook_url:
          type:
            - string
            - 'null'
          title: Webhook url
          format: uri
          description: >-
            URL for sending updates on a parcel. A value for `webhook_url` is
            required if `webhook_active` is set to `true`.
          minLength: 1
          example: https://my-shop-integration.integrator/api/webhooks/sendcloud
        feedback_type:
          type: string
          title: Feedback Type
          enum:
            - eager
            - delayed
            - none
          description: >-
            Define how your shop status feedback should be sent into your
            system. 

            Note that this will not apply to Prestashop V2 as the custom status
            mapping will define this.  

            Use the following states:
               - eager: Change the parcels’ status to “sent” once the label is created.
               - delayed: Change the parcels’ status to “sent” once the carrier scans the label.
               - none: Don’t send any feedback.
          minLength: 1
    ErrorObject:
      title: Error
      type: object
      description: Error in a JSON:API error format
      properties:
        id:
          type: string
          description: A unique identifier for the error.
        links:
          type: object
          description: >-
            A set of hyperlinks that provide additional information about the
            error.
          properties:
            about:
              type: string
              description: A URL that provides additional information about the error.
        status:
          type: string
          format: int32
          description: The HTTP status code of the error.
          minLength: 1
        code:
          type: string
          description: A unique error code for the error, in snake case format.
          minLength: 1
          enum:
            - unknown_field
            - invalid
            - forbidden
            - invalid_choice
            - min_value
            - 'null'
            - not_found
            - required
            - not_a_list
            - non_field_errors
            - authentication_failed
            - validation_error
            - parcel_announcement_error
        title:
          type: string
          description: A short, human-readable summary of the error.
          minLength: 1
        detail:
          type: string
          description: A human-readable explanation of the error.
          minLength: 1
        source:
          type: object
          description: >-
            An object that identifies the source of the error within the request
            payload.
          properties:
            pointer:
              type: string
              description: >-
                A `JSON` pointer to the location of the error within the request
                payload.
            parameter:
              type: string
              description: The name of the `query` parameter that caused the error.
            header:
              type: string
              description: The name of the `header` parameter that caused the error.
        meta:
          type: object
          description: Additional metadata about the error.
  securitySchemes:
    HTTPBasicAuth:
      type: http
      description: >-
        Basic Authentication using API key and secrets is currently the main
        authentication mechanism.
      scheme: basic

````