{
  "opencollection": "1.0.0",
  "info": {
    "name": "Shipments Address Integrations API",
    "version": "3.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Integrations",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Retrieve a list of integrations",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://panel.sendcloud.sc/api/v3/integrations",
            "params": [
              {
                "name": "ordering",
                "value": "",
                "type": "query",
                "description": "Specifies the field used to order the resulting response"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Retrieve information about all the shop integrations currently connected to your Sendcloud account."
        },
        {
          "info": {
            "name": "Retrieve an integration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://panel.sendcloud.sc/api/v3/integrations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the integration"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Retrieve information about a specific integration using its `id`."
        },
        {
          "info": {
            "name": "Update an integration",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://panel.sendcloud.sc/api/v3/integrations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the integration"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Update settings for a specific integration using its `id`."
        },
        {
          "info": {
            "name": "Partially update an integration",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://panel.sendcloud.sc/api/v3/integrations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the integration"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Partially update settings for a specific integration using its `id`."
        },
        {
          "info": {
            "name": "Delete an integration",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://panel.sendcloud.sc/api/v3/integrations/:id",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the integration"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Delete a shop integration from the Sendcloud system."
        },
        {
          "info": {
            "name": "Retrieve all integration exception logs",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://panel.sendcloud.sc/api/v3/integrations/logs",
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Retrieve all integration exception logs. These logs are created when integrations have problems making API requests to shop systems."
        },
        {
          "info": {
            "name": "Retrieve exception logs for a specific integration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://panel.sendcloud.sc/api/v3/integrations/:id/logs",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the integration to which the shipments belong"
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Retrieve exception logs for a specific integration. These logs are created when integrations have problems making API requests to shop systems."
        },
        {
          "info": {
            "name": "Create integration exceptions logs",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://panel.sendcloud.sc/api/v3/integrations/:id/logs",
            "params": [
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "The id of the integration to which the shipments belong"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Create integration exception logs, which will appear in the connection issue log screen of the user's integration."
        },
        {
          "info": {
            "name": "Retrieve shop order statuses for an integration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://panel.sendcloud.sc/api/v3/shop-order-statuses",
            "params": [
              {
                "name": "integration_id",
                "value": "",
                "type": "query",
                "description": "Filter response on `integration_id`."
              },
              {
                "name": "language",
                "value": "en-gb",
                "type": "query",
                "description": "Get a response for the specified language."
              },
              {
                "name": "show_deleted",
                "value": "true",
                "type": "query",
                "description": "Get all currently available and historical statuses."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Fetch all available shop order statuses for the Prestashop v2 integration, in the default or selected language."
        },
        {
          "info": {
            "name": "Create or overwrite shop order statuses",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://panel.sendcloud.sc/api/v3/shop-order-statuses",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Insert shop-specific custom statuses into the Sendcloud system."
        },
        {
          "info": {
            "name": "Retrieve custom status mapping for an integration",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://panel.sendcloud.sc/api/v3/shop-order-statuses/mapping",
            "params": [
              {
                "name": "integration_id",
                "value": "",
                "type": "query",
                "description": "Filter response on `integration_id`."
              }
            ],
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Fetch a map of available shop order statuses and Sendcloud's internal status category for the integration.\n"
        },
        {
          "info": {
            "name": "Create or update custom status mapping for an integration",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://panel.sendcloud.sc/api/v3/shop-order-statuses/mapping",
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "basic",
              "username": "{{username}}",
              "password": "{{password}}"
            }
          },
          "docs": "Upsert a map of available shop order statuses and Sendcloud's internal status category for an integration"
        }
      ]
    }
  ],
  "bundled": true
}