StockSupplier Data Type

A wholesaler whose warehouse stock can be sourced for the products you sell. Serialized as stockSupplier, and named stockSupplier as a record of the paged envelope.

Properties
Name Type Description
id number Unique numeric identifier of the supplier, and what the availability endpoint takes in its path.
ownerAccount Account The account the supplier record belongs to. Suppliers are configured platform-wide, so this is the platform's own account rather than yours.
name string Short name of the supplier, as shown in the back office.
description string
logoPath string
deleted boolean
enabled boolean Whether the supplier is switched on at all on the platform.
enabledForAccount boolean Whether the account named in the request path may source from this supplier.
type StockSupplierModuleType Which supplier integration feeds this record's stock data.
lastError string
lastRun number
lastSuccess number
version number
Used in
StockSupplier (JSON)
{
  "stockSupplier" : {
    "id" : 12345,
    "ownerAccount" : {
      "id" : 12345,
      "name" : "...",
      "fullName" : "...",
      "affiliateId" : "...",
      "accountDataRetention" : {
        "id" : 12345,
        "keepPersonalDataMonths" : 12345,
        "keepPrintDataMonths" : 12345
      },
      "persitenceConfig" : { }
    },
    "name" : "...",
    "description" : "...",
    "logoPath" : "...",
    "deleted" : true,
    "enabled" : true,
    "enabledForAccount" : true,
    "type" : "BRANDEX",
    "lastError" : "...",
    "lastRun" : 12345,
    "lastSuccess" : 12345,
    "version" : 12345
  }
}
StockSupplier Data Type

A wholesaler whose warehouse stock can be sourced for the products you sell. Serialized as stockSupplier, and named stockSupplier as a record of the paged envelope.

Properties
Name Type Description
deleted boolean  
description string  
enabled boolean Whether the supplier is switched on at all on the platform.
enabledForAccount boolean Whether the account named in the request path may source from this supplier.
id int Unique numeric identifier of the supplier, and what the availability endpoint takes in its path.
lastError string  
lastRun dateTime  
lastSuccess dateTime  
logoPath string  
name string Short name of the supplier, as shown in the back office.
ownerAccount Account The account the supplier record belongs to. Suppliers are configured platform-wide, so this is the platform's own account rather than yours.
type stockSupplierModuleType Which supplier integration feeds this record's stock data.
version int  
Used in
StockSupplier (XML)
<stockSupplier>
  <id>...</id>
  <ownerAccount>
    <id>...</id>
    <name>...</name>
    <fullName>...</fullName>
    <affiliateId>...</affiliateId>
    <accountDataRetention>
      <id>...</id>
      <keepPersonalDataMonths>...</keepPersonalDataMonths>
      <keepPrintDataMonths>...</keepPrintDataMonths>
    </accountDataRetention>
    <persitenceConfig>
      <id>...</id>
      <archiveDays>...</archiveDays>
      <deleteDays>...</deleteDays>
    </persitenceConfig>
  </ownerAccount>
  <name>...</name>
  <description>...</description>
  <logoPath>...</logoPath>
  <deleted>...</deleted>
  <enabled>...</enabled>
  <enabledForAccount>...</enabledForAccount>
  <type>...</type>
  <lastError>...</lastError>
  <lastRun>...</lastRun>
  <lastSuccess>...</lastSuccess>
  <version>...</version>
</stockSupplier>