Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

You can use either carrierId or carrierCode and carrierName but you cannot use both parameters at the same time. We recommend to use the carrierId which can be obtained from the carrier.list API method.

 

...

Code Block
themeFadeToGrey
titleSample 1
Code Block
{
  "authenticationToken": "token_info_goes_here",
  "customerId": 99999,
  "carrierCode": "AR", 
  "carrierName": "Armellini", 
  "shipDate": "2014-04-10",
  "poNumber": "PO9999",
  "reference" : "R99999", 
  "instructions": "Text for instructions", 
  "labelInstructions": "Text for label instructions",
  "items": 
   [
    {
      "orderItemId": 9999999,   
      "boxes": 5, 
      "price": 2.50,
      "markCode": "text for mark code", 
      "productAlias" : "text for product alias", 
      "notes": "text for notes"
    }
 ]
}

...

Code Block
themeFadeToGrey
titleSample 2
Code Block
{
  "authenticationToken": "token_info_goes_here",
  "customerId": 99999,
  "carrierCode": "AR", 
  "carrierName": "Armellini", 
  "shipDate": "2014-04-10",
  "poNumber": "PO9999",
  "reference" : "R99999", 
  "instructions": "Text for instructions", 
  "labelInstructions": "Text for label instructions",
  "items": 
   [
    {
      "productCode": "RS50",
      "boxTypeCode": "HB",
      "unitsPerBox": 150,
      "unitType": "Stem",   
      "boxes": 5, 
      "price": 2.50,
      "markCode": "text for mark code", 
      "productAlias" : "text for product alias", 
      "notes": "text for notes"
    }
 ]
}

...

  • status (integer:1): Transaction status. 1 for success or 0 for failure.
  • message (string:500): Description of the status of the transaction.
  • invoiceId (integer:20): Invoice id.
  • invoiceNumber (integer:10): Invoice number.
  • availableBoxes (integer:10): Number of boxes that are available if the transactions fails. Under construction

Code Block
themeFadeToGrey
titleSample 1

 

Code Block
 {
  "status": "1",
  "message": "success",
  "invoiceId": 111111111,
  "invoiceNumber": 85443
 }
Code Block
themeFadeToGrey
titleSample 2

...

 

code
 {
  "status": "0",
  "message": "Item is not available",
  "invoiceId": 111111111,
  "invoiceNumber": 85443,
  "availableBoxes":2
 }

...