LIlinnworks
ShipStation

CreateShipStationIntegration

Used for ShipStation to create a new ShipStation integration

post/api/ShipStation/CreateShipStationIntegration

Request

  • Base URL
    https://eu-ext.linnworks.net
  • URL
    https://eu-ext.linnworks.net/api/ShipStation/CreateShipStationIntegration
  • Auth
    API key in header Authorization

Request body

Example request

{
  "integration": {
    "ExportLocations": [
      "00000000-0000-0000-0000-000000000000"
    ],
    "ExportFolder": "00000000-0000-0000-0000-000000000000",
    "AutoProcessOrdersLocation": "00000000-0000-0000-0000-000000000000",
    "DefaultShipServiceShipStation": "00000000-0000-0000-0000-000000000000",
    "DefaultShipServiceLinnworks": "00000000-0000-0000-0000-000000000000",
    "ShipServices": [
      {
        "ShipStationServiceId": "00000000-0000-0000-0000-000000000000",
        "LinnworksServiceId": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
}

Response

OK

ConfigVinteger

Config version (for legacy purposes)

ConfigIdstring

A unique identifier for the config within Linnworks

Namestring

An identifier for the config within Linnworks

Enabledboolean

Defines whether the config is enabled

ExportLocationsstring[]

The order locations to look for orders in

ExportFolderstring uuid

The order folder to export orders from

LastSyncstring date-time

The last sync date with ShipStation

AutoProcessOrdersLocationstring uuid

The location to process orders from

ExportChildItemsboolean

Toggles whether or not to export child items

ImportedOrderTaginteger

The order tag to assign ShipStation imported orders

DefaultShipServiceShipStationstring uuid

The default ShipStation shipping service

DefaultShipServiceLinnworksstring uuid

The default Linnworks shipping service

UseChannelDataboolean

Toggles between sending channel SKU/Title or linnworks SKU/Title to ShipStation

WeightUnit'none' | 'oz' | 'lb' | 'gm' | 'kg'

The weight unit for order items

CustomOrderField1string

A custom field allowing user to pass custom information about the order

CustomOrderField2string

A custom field allowing user to pass custom information about the order

CustomOrderField3string

A custom field allowing user to pass custom information about the order

Example response

{
  "ExportLocations": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "ExportFolder": "00000000-0000-0000-0000-000000000000",
  "AutoProcessOrdersLocation": "00000000-0000-0000-0000-000000000000",
  "DefaultShipServiceShipStation": "00000000-0000-0000-0000-000000000000",
  "DefaultShipServiceLinnworks": "00000000-0000-0000-0000-000000000000",
  "ShipServices": [
    {
      "ShipStationServiceId": "00000000-0000-0000-0000-000000000000",
      "LinnworksServiceId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.