Overview

Create a product which a service provider will provide.

Creating a Product

To create a product:

  1. Create a CreateProduct request.
  2. Provide required information: 
    - Name.
    - Description.
    - Product Type.
    - Product Category.
    - Allow Inventory.
    - Serialised Product.
  3. Optionally provide information: 
    - Product Subcategory.
    - Manufacturer.
    - Colour.
    - SKU.
    - Supplier Name.
    - Supplier Product ID.
    - Barcode.
    - Ledger Code.
    - Encrypt Serial Number.
    - Allow Fractional Quantity.
    - Can Assign Service.
    - Tax Type.
    - Price Type Group.
    - Price Type.

WSDL

https://api.emersion.com.au/Products.wsdl

Operation name

Products/CreateProduct



Business Rules

- Name is within length limit. (128)
- Description should be within length limit. (255)
- Product Type should exist in list (have 'MOD_CR_PRODUCT' power for 'Credit'.
- Product Category should exist in list and be owned by Emersion or Caller.
- Product Subcategory should exist in list and be valid under Product Category.
- Manufacturer should exist in list.
- Colour should exist in list. (enum: 'ProductColour')
- SKU should be within length limit. (100) 
Supplier Name should be within length limit. (255)
- Supplier Product ID should within length limit. (100)
- Barcode Type should exist in list, Barcode Value should within length limit (100) and both should coexist.
- Ledger code should exist in list, otherwise will be created newly and should be within length limit. (200)
- Allow Inventory, Serialised Product, Encrypt Serial Number and Allow Fractional Quantity should be boolean.
- Can Assign Service should exist in list. (enum: 'ProductInstServiceAssign')
- Tax Type should exist in list.
- Price Type Group should exist in list. (enum: 'ProductTypeGroup')
- Price Type should exist in list and be valid under Product Type Group. (enum: 'ProductType')




SOAP Example

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:urn="urn:emersion:api" xmlns:urn1="urn:emersion:types">
   <soapenv:Header/>
   <soapenv:Body>
      <urn:CreateProductRequest>
         <urn:Name>MelbourneJames1</urn:Name>
         <urn:Description>James Kim Test1</urn:Description>
         <urn:Type>Physical Product</urn:Type>
         <urn:Category>Hardware</urn:Category>
         <!--Optional:-->
         <urn:Subcategory>PSTN Gateways</urn:Subcategory>
         <!--Optional:-->
         <urn:Colour>White</urn:Colour>
         <!--Optional:-->
         <urn:SKU>CHG-SEL-4015</urn:SKU>
         <!--Optional:-->
         <urn:Supplier>Ingram Micro</urn:Supplier>
         <!--Optional:-->
         <urn:SupplierProductCode>14201-17</urn:SupplierProductCode>
         <!--Optional:-->
         <urn:Barcode>
            <urn1:Type>Code 128</urn1:Type>
            <urn1:Shortname>Code 128</urn1:Shortname>
            <urn1:Value>998877665544332211</urn1:Value>
         </urn:Barcode>
         <!--Optional:-->
         <urn:LedgerCode>JAMES_TEST0</urn:LedgerCode>
         <urn:AllowInventory>true</urn:AllowInventory>
         <urn:SerialisedProduct>true</urn:SerialisedProduct>
         <!--Optional:-->
         <urn:EncryptSerialNumbers>true</urn:EncryptSerialNumbers>
         <!--Optional:-->
         <urn:AllowFractionalQuantity>true</urn:AllowFractionalQuantity>
         <!--Optional:-->
         <urn:CanAssignService>optional</urn:CanAssignService>
         <!--Optional:-->
         <urn:TaxType>Australian GST</urn:TaxType>
<!--Optional:-->
<urn:PriceTypeGroup>Default</urn:PriceTypeGroup>
<!--Optional:-->
<urn:PriceTypee>Unit(s)</urn:PriceType>
</urn:CreateProductRequest>
</soapenv:Body>
</soapenv:Envelope>




Field Descriptions

All field names are case sensitive. Check enumerated values in the descriptions to confirm capitalisation and spacing. See field types for additional information.

NameDescriptionRequired?Field Type

Character

limit

Values

Name

Product nameYesString128

Jabra Elite 65t

Description

Product descriptionYesString255Wireless Earbud Headphones

Type

Product typeYesEnumeration

Service Charge, Billable Item, Physical Product, Labour, Voucher, Credit

Category

Product categoryYes

String




Hardware

Subcategory

Product subcategory under its categoryNo

String




PSTN Gateways

Manufacturer

Product manufacturer under its categoryNoString

Samsung

ColourProduct colourNoEnumeration
White
SKU

Stock Keeping Unit, service identification code for a product

NoString100CHG-SEL-4015
SupplierSupplier nameNoString255Ingram Micro
SupplierProductCodeSupplier Product IDNoString10014201-17
Barcode

Barcode type
Barcode short name
Barcode value

No
No
No

String
String
String


Code 128
Code 128
998877665544332211

LedgerCodeLedger codeNoString200VOCUS_SIP_TRUNK_RECUR
AllowInventoryAllow inventoryYesBoolean
true
SerialisedProductSerialised productYesBoolean
true
EncryptSerialNumberEncrypt serial numberNoBoolean
true
AllowFractionalQuantityAllow fractional quantityNoBoolean
true
CanAssignServiceCan assign serviceNoEnumeration
optional
TaxTypeTax typeNoString
Australian GST
PriceTypeGroupProduct price type groupNoEnumeration
Default
PriceTypeProduct price type under its price type groupNoEnumeration
Unit(s)