customers channel (http://api.3plcentral.com/rels/customers/channel)
Resource:
defines periodic import/export
C# Rel Const:
Rels.CustomerSvc.Channel
URI template:
{id}/channels/{iid}
Obtain URI from:
Get an import channel record
Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int customer id
iid * int import channel id
Type Description
SkipInvalid bool true: create as many as possible; false: all or nothing
ReadOnly Customer.Models.ChannelReadOnly
ChannelId int
CreatedDate DateTime? ...
LastChangedDate DateTime? ...
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
CustomerDeactivated bool
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
ResourceType Common.Enum.ChannelResourceType
- 0: Order
- 1: Receiver
- 2: Item
Provider string
Name string
Deactivated bool if true, this channel should not be used; either channel or customer is deactivated; see CustomerDeactivated to distinguish
ScheduleCron string
TransformIdentifier Generic.Models.TransformIdentifier
Name string
Id int
ProviderParams IEnumerable<Generic.Models.SavedElement> parameters
Name string
Value string
Sample accept: application/hal+json
{
  "skipInvalid": true,
  "readOnly": {
    "channelId": 1,
    "createdDate": "2016-12-25T23:00:00",
    "lastChangedDate": "2016-12-25T23:00:00",
    "customerIdentifier": {
      "externalId": "str",
      "name": "str",
      "id": 3
    },
    "customerDeactivated": true,
    "facilityIdentifier": {
      "name": "str",
      "id": 2
    },
    "resourceType": 0,
    "provider": "str"
  },
  "name": "str",
  "deactivated": true,
  "scheduleCron": "str",
  "transformIdentifier": {
    "name": "str",
    "id": 2
  },
  "providerParams": [
    {
      "name": "str",
      "value": "str"
    }
  ]
}
Success status: 200; ETag response header supplied
Name (* = required) Data Type Description
id * int
iid * int
Type Description
SkipInvalid bool true: create as many as possible; false: all or nothing
ReadOnly Customer.Models.ChannelReadOnly
ChannelId int
CreatedDate DateTime? ...
LastChangedDate DateTime? ...
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
CustomerDeactivated bool
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
ResourceType Common.Enum.ChannelResourceType
- 0: Order
- 1: Receiver
- 2: Item
Provider string
Name string
Deactivated bool if true, this channel should not be used; either channel or customer is deactivated; see CustomerDeactivated to distinguish
ScheduleCron string
TransformIdentifier Generic.Models.TransformIdentifier
Name string
Id int
ProviderParams IEnumerable<Generic.Models.SavedElement> parameters
Name string
Value string
Sample content-type: application/hal+json
{
  "skipInvalid": true,
  "readOnly": {
    "channelId": 1,
    "createdDate": "2016-12-25T23:00:00",
    "lastChangedDate": "2016-12-25T23:00:00",
    "customerIdentifier": {
      "externalId": "str",
      "name": "str",
      "id": 3
    },
    "customerDeactivated": true,
    "facilityIdentifier": {
      "name": "str",
      "id": 2
    },
    "resourceType": 0,
    "provider": "str"
  },
  "name": "str",
  "deactivated": true,
  "scheduleCron": "str",
  "transformIdentifier": {
    "name": "str",
    "id": 2
  },
  "providerParams": [
    {
      "name": "str",
      "value": "str"
    }
  ]
}
Type Description
SkipInvalid bool true: create as many as possible; false: all or nothing
ReadOnly Customer.Models.ChannelReadOnly
ChannelId int
CreatedDate DateTime? ...
LastChangedDate DateTime? ...
CustomerIdentifier Generic.Models.CustomerIdentifier
ExternalId string
Name string
Id int
CustomerDeactivated bool
FacilityIdentifier Generic.Models.FacilityIdentifier
Name string
Id int
ResourceType Common.Enum.ChannelResourceType
- 0: Order
- 1: Receiver
- 2: Item
Provider string
Name string
Deactivated bool if true, this channel should not be used; either channel or customer is deactivated; see CustomerDeactivated to distinguish
ScheduleCron string
TransformIdentifier Generic.Models.TransformIdentifier
Name string
Id int
ProviderParams IEnumerable<Generic.Models.SavedElement> parameters
Name string
Value string
Sample accept: application/hal+json
{
  "skipInvalid": true,
  "readOnly": {
    "channelId": 1,
    "createdDate": "2016-12-25T23:00:00",
    "lastChangedDate": "2016-12-25T23:00:00",
    "customerIdentifier": {
      "externalId": "str",
      "name": "str",
      "id": 3
    },
    "customerDeactivated": true,
    "facilityIdentifier": {
      "name": "str",
      "id": 2
    },
    "resourceType": 0,
    "provider": "str"
  },
  "name": "str",
  "deactivated": true,
  "scheduleCron": "str",
  "transformIdentifier": {
    "name": "str",
    "id": 2
  },
  "providerParams": [
    {
      "name": "str",
      "value": "str"
    }
  ]
}
Success status: 204
Name (* = required) Data Type Description
id * int
iid * int

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.