packing-slips

packing-slips.find
packing-slips.get
packing-slips.count
packing-slips.create
packing-slips.update
packing-slips.delete

packing-slips.find

Returns the packing slips that meet the given conditions.

Request

Admin SDK
Admin.api('commerce.packing-slips.find', request, function(response) { … });

HTTP POST
/api/v6/commerce.packing-slips.find

{
  "conditions" : { // returns only the packing slips …
    "ids" : [ 662705500, … ], // … with these identifiers - int(1…)
    "status" : "Open", // … with this status, can be "Open", "Shipped" or "Cancelled" - string
    "fromNumber" : "7890", // … with a number greater or equal to this - string(1…32)
    "toNumber" : "8152", // … with a number lower ot equal to this - string(1…32)
    "fromCreationTime" : "2013-08-01 12:00:00", // … with creation time equal or next to this - datetime
    "toCreationTime" : "2013-09-08 12:00:00", // … with creation time equal or previous to this - datetime
    "fromUpdateTime" : "2013-09-01 12:00:00", // … with last update time equal or next to this - datetime
    "toUpdateTime" : "2013-12-31 23:59:59", // … with last update time equal or previous to this - datetime
    "customer" : 4907, // … of this customer (id) - int(1…)
    "address" : "Baker Street" // … with this phrase in the address - string(1…30)
    "labels" : [ 1, 3, … ], // … with these labels - int(1…64)
    "after" : 925669584 // … with identifier after this value - int(0…)  },
  "fields" : [ "number", "status", … ],  // returns only these fields - string
  "order" : [ "number" ], // sort order of returned packed slips, can contain "id", "-id", "number", "-number",
                          // "status", "-status", "creationTime", "-creationTime", "updateTime", "-updateTime",
                          // "total", "-total", "taxedTotal", "-taxedTotal", "customerName" and "-customerName" - string
  "limit" : 10, // maximum number of packing slips to return - int(1…)
  "first" : 0 // index of the first packing slip to return - int(0…)
}

Response

{
  "status" : "ok",
  "packingSlips" : [ {
    "id" : 662705500, // identifier - int(1…)
    "number" : "2013/90471", // number - string(0…32)
    "status" : "Open", // status, can be "Open", "Shipped" or "Cancelled" - string
    "creationTime" : "2013-09-03 13:13:47", // creation time - datetime
    "updateTime" : "2013-09-03 16:08:11", // last update time - datetime
    "shippingTime" : "2013-09-04 11:56:27", // shipping time (can be null) - datetime
    "referenceType" : "Order", // reference type, can be "Order", "Quote", "Invoice", "ShippingInvoice", "Proforma", "CreditNote", "Receipt" or "PackingSlip" (can be null) - string
    "referenceNumber" : "2013/30991", // reference number - string(0…32)
    "customer" : 37091, // customer (id) (can be null) - int(1…)
    "rounding" : { // rounding
      "mode" : "HalfUp",  // mode, can be "Down", "HalfDown", "HalfEven" or "HalfUp" - string
      "rule" : "PerItem"  // rule, can be "PerItem", "PerLine" or "Total" - string
    },
    "locale" : "en-GB", // locale (ISO code) of the customer, region is not mandatory - string(2…5)
    "taxArea" : 7, // tax area (id) used for tax calculations - int(1…)
    "items" : [ { // items
      "sku" : "A927TP", // SKU - string(0…40)
      "name" : "Shirt", // name - string(0…255)
      "quantity" : 3.00, // quantity - decimal[8,2](0…)
      "price" : 56.330, // price (excluded taxes) - decimal[10,3]
      "totalPrice" : 168.99, // total price (excluded taxes) - decimal[10,2]
      "weight" : 0.450, // weight - decimal[8,3](0…)
      "taxCode" : "VAT", // tax code - string(0…32)
      "taxRate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxAmount" : 112.66, // tax amount - decimal[10,2]
      "requests" : "..." // customer requests - string(0…255)
    }, … ],
    "prediscountSubtotal" : 69.54, // prediscount subtotal - decimal[10,2]
    "taxedPrediscountSubtotal" : 110.89, // prediscount subtotal, taxes included - decimal[10,2]
    "discounts" : [ { // discounts, up to 5
      "type" : "PercentOff", // type, can be "PercentOff" or "AmountOff" - string
      "value" : 20.000 // value, must be greater than zero and if percentage must be less than or equal to 100 - decimal[8,3](0…)
    }, {
      "type" : "AmountOff",
      "value" : 10.450
    }, … ],
    "discountsIncludeTaxes" : false, // indicates if discounts include taxes - bool
    "subtotal" : 69.54, // subtotal - decimal[10,2]
    "taxedSubtotal" : 110.89, // subtotal, taxes included - decimal[10,2]
    "shippingMethod" : { // shipping method (can be null)
      "id" : 14, // identifier (can be null) - int(1…)
      "name" : "FedEx", // name - string(1…80)
      "cost" : 8.572, // cost - decimal[8,3](0…)
      "taxCode" : "TVA", // tax code - string(0…32)
      "taxRate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxAmount" : 1.63 // amount of tax - decimal[8,2](0…)
    },
    "paymentMethod" : { // payment method (can be null)
      "id" : 3, // identifier (can be null) - int(1…)
      "name" : "Credit Card", // name - string(1…80)
      "cost" : 1.200, // cost (fee) - decimal[8,3](0…)
      "taxCode" : "TVA", // tax code - string(0…32)
      "taxRate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxAmount" : 0.23 // amount of tax - decimal[8,2](0…)
    },
    "taxes" : [ { // taxes for each tax class
      "code" : "VAT", // tax class code - string(0…32)
      "name" : "Generic", // tax class name - string(0…60)
      "rate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxableTotal" : 89.23, // taxable total - decimal[10,2]
      "amount" : 31.25 // tax amount - decimal[10,2]
    }, … ],
    "taxAmount" : 31.25, // tax amount - decimal[10,2]
    "total" : 89.23, // total - decimal[10,2]
    "taxedTotal" : 120.48, // total, taxes included - decimal[10,2]
    "quantity" : 7.00, // total number of items quantity - decimal[10,2](0…)
    "weight" : 1.351, // total weight of items - decimal[8,3](0…)
    "customerName" : "Investigations Inc", // customer's name ( last and first name or company name ) - string(1…100)
    "billingAddress" : { // billing address
      "firstName" : "Sherlock", // first name - string(1…25)
      "lastName" : "Holmes", // last name - string(1…25)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "companyCode2" : "7J BA3 006", // second company code number - string(0…20)
      "street1" : "221b Baker Street", // street, first row - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(1…25)
      "postalCode" : "NW1 6XE", // postal code - string(1…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) - string(2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address - string(3…120)    },
    "shippingAddress" : { // shipping address (can be null)
      "name" : "John", // recipient name - string(1…100)
      "street1" : "221b Baker Street", // street, first row - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(1…25)
      "postalCode" : "NW1 6XE", // postal code - string(1…20)
      "stateProv" : "LND", // province, state or county - string(0…3)
      "country" : "GB" // country (ISO code) - string(2)    },
    "sellerAddress" : { // seller address
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "street1" : "221b Baker Street", // street, first row - string(0…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(0…25)
      "postalCode" : "NW1 6XE", // postal code - string(0…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) - string(0…2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address - string(0…120)    },
    "numberOfPackages" : 1, // number of packages - int(1…100)
    "porto" : "Franco", // porto, can be "Franco" or "Assegnato" (can be null) - string
    "goodsAppearance" : "Five cardboard boxes", // goods appearance - string(0…255)
    "trackingNumber" : "rt-5pl7f-fg", // tracking number - string(0…64)
    "transportReason" : "Order shipment", // transport reason - string(0…255)
    "terms" : "" // terms and conditions - string(0…65535)  }, … ]
}

packing-slips.get

Returns a packing slip given its identifier.

Request

Admin SDK
Admin.api('commerce.packing-slips.get', request, function(response) { … });

HTTP POST
/api/v6/commerce.packing-slips.get

{
  "id" : 662705500, // identifier (required) - int(1…)
  "fields" : [ "number", "status", … ] // fields to return - string
}

Response

{
  "status" : "ok",
  "packingSlip" : { // (can be null)
    "id" : 662705500, // identifier - int(1…)
    "number" : "2013/90471", // number - string(0…32)
    "status" : "Open", // status, can be "Open", "Shipped" or "Cancelled" - string
    "creationTime" : "2013-09-03 13:13:47", // creation time - datetime
    "updateTime" : "2013-09-03 16:08:11", // last update time - datetime
    "shippingTime" : "2013-09-04 11:56:27", // shipping time (can be null) - datetime
    "referenceType" : "Order", // reference type, can be "Order", "Quote", "Invoice", "ShippingInvoice", "Proforma", "CreditNote", "Receipt" or "PackingSlip" (can be null) - string
    "referenceNumber" : "2013/30991", // reference number - string(0…32)
    "customer" : 37091, // customer (id) (can be null) - int(1…)
    "rounding" : { // rounding
      "mode" : "HalfUp",  // mode, can be "Down", "HalfDown", "HalfEven" or "HalfUp" - string
      "rule" : "PerItem"  // rule, can be "PerItem", "PerLine" or "Total" - string
    },
    "locale" : "en-GB", // locale (ISO code) of the customer, region is not mandatory - string(2…5)
    "taxArea" : 7, // tax area (id) used for tax calculations - int(1…)
    "items" : [ { // items
      "sku" : "A927TP", // SKU - string(0…40)
      "name" : "Shirt", // name - string(0…255)
      "quantity" : 3.00, // quantity - decimal[8,2](0…)
      "price" : 56.330, // price (excluded taxes) - decimal[10,3]
      "totalPrice" : 168.99, // total price (excluded taxes) - decimal[10,2]
      "weight" : 0.450, // weight - decimal[8,3](0…)
      "taxCode" : "VAT", // tax code - string(0…32)
      "taxRate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxAmount" : 112.66, // tax amount - decimal[10,2]
      "requests" : "..." // customer requests - string(0…255)
    }, … ],
    "prediscountSubtotal" : 69.54, // prediscount subtotal - decimal[10,2]
    "taxedPrediscountSubtotal" : 110.89, // prediscount subtotal, taxes included - decimal[10,2]
    "discounts" : [ { // discounts, up to 5
      "type" : "PercentOff", // type, can be "PercentOff" or "AmountOff" - string
      "value" : 20.000 // value, must be greater than zero and if percentage must be less than or equal to 100 - decimal[8,3](0…)
    }, {
      "type" : "AmountOff",
      "value" : 10.450
    }, … ],
    "discountsIncludeTaxes" : false, // indicates if discounts include taxes - bool
    "subtotal" : 69.54, // subtotal - decimal[10,2]
    "taxedSubtotal" : 110.89, // subtotal, taxes included - decimal[10,2]
    "shippingMethod" : { // shipping method (can be null)
      "id" : 14, // identifier (can be null) - int(1…)
      "name" : "FedEx", // name - string(1…80)
      "cost" : 8.572, // cost - decimal[8,3](0…)
      "taxCode" : "TVA", // tax code - string(0…32)
      "taxRate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxAmount" : 1.63 // amount of tax - decimal[8,2](0…)
    },
    "paymentMethod" : { // payment method (can be null)
      "id" : 3, // identifier (can be null) - int(1…)
      "name" : "Credit Card", // name - string(1…80)
      "cost" : 1.200, // cost (fee) - decimal[8,3](0…)
      "taxCode" : "TVA", // tax code - string(0…32)
      "taxRate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxAmount" : 0.23 // amount of tax - decimal[8,2](0…)
    },
    "taxes" : [ { // taxes for each tax class
      "code" : "VAT", // tax class code - string(0…32)
      "name" : "Generic", // tax class name - string(0…60)
      "rate" : 19.00, // percent tax - decimal[4,2](0…)
      "taxableTotal" : 89.23, // taxable total - decimal[10,2]
      "amount" : 31.25 // tax amount - decimal[10,2]
    }, … ],
    "taxAmount" : 31.25, // tax amount - decimal[10,2]
    "total" : 89.23, // total - decimal[10,2]
    "taxedTotal" : 120.48, // total, taxes included - decimal[10,2]
    "quantity" : 7.00, // total number of items quantity - decimal[10,2](0…)
    "weight" : 1.351, // total weight of items - decimal[8,3](0…)
    "customerName" : "Investigations Inc", // customer's name ( last and first name or company name ) - string(1…100)
    "billingAddress" : { // billing address
      "firstName" : "Sherlock", // first name - string(1…25)
      "lastName" : "Holmes", // last name - string(1…25)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "companyCode2" : "7J BA3 006", // second company code number - string(0…20)
      "street1" : "221b Baker Street", // street, first row - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(1…25)
      "postalCode" : "NW1 6XE", // postal code - string(1…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) - string(2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address - string(3…120)    },
    "shippingAddress" : { // shipping address (can be null)
      "name" : "John", // recipient name - string(1…100)
      "street1" : "221b Baker Street", // street, first row - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(1…25)
      "postalCode" : "NW1 6XE", // postal code - string(1…20)
      "stateProv" : "LND", // province, state or county - string(0…3)
      "country" : "GB" // country (ISO code) - string(2)    },
    "sellerAddress" : { // seller address
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "street1" : "221b Baker Street", // street, first row - string(0…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(0…25)
      "postalCode" : "NW1 6XE", // postal code - string(0…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) - string(0…2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address - string(0…120)    },
    "numberOfPackages" : 1, // number of packages - int(1…100)
    "porto" : "Franco", // porto, can be "Franco" or "Assegnato" (can be null) - string
    "goodsAppearance" : "Five cardboard boxes", // goods appearance - string(0…255)
    "trackingNumber" : "rt-5pl7f-fg", // tracking number - string(0…64)
    "transportReason" : "Order shipment", // transport reason - string(0…255)
    "terms" : "" // terms and conditions - string(0…65535)  }
}

packing-slips.count

Number of packing slips that meet the given conditions.

Request

Admin SDK
Admin.api('commerce.packing-slips.count', request, function(response) { … });

HTTP POST
/api/v6/commerce.packing-slips.count

{
  "conditions" : { // counts the packing slips …
    "ids" : [ 662705500, … ], // … with these identifiers - int(1…)
    "status" : "Open", // … with this status, can be "Open", "Shipped" or "Cancelled" - string
    "fromNumber" : "7890", // … with a number greater or equal to this - string(1…32)
    "toNumber" : "8152", // … with a number lower ot equal to this - string(1…32)
    "fromCreationTime" : "2013-08-01 12:00:00", // … with creation time equal or next to this - datetime
    "toCreationTime" : "2013-09-08 12:00:00", // … with creation time equal or previous to this - datetime
    "fromUpdateTime" : "2013-09-01 12:00:00", // … with last update time equal or next to this - datetime
    "toUpdateTime" : "2013-12-31 23:59:59", // … with last update time equal or previous to this - datetime
    "customer" : 4907, // … of this customer (id) - int(1…)
    "address" : "Baker Street" // … with this phrase in the address - string(1…30)
    "labels" : [ 1, 3, … ], // … with these labels - int(1…64)
    "after" : 925669584 // … with identifier after this value - int(0…)  }
}

Response

{
  "status" : "ok",
  "count" : 547 // number of packing slips - int(0…)
}

packing-slips.create

Creates a new packing slip.

Request

Admin SDK
Admin.api('commerce.packing-slips.create', request, function(response) { … });

HTTP POST
/api/v6/commerce.packing-slips.create

{
  "packingSlip" : { // packing slip to create (required)
    "number" : "2013/90471", // number - string(0…32)
    "status" : "Open", // status, can be "Open", "Shipped" or "Cancelled"
    "creationTime" : "2013-09-01 12:00:00", // creation time, if empty it takes the current time - datetime
    "shippingTime" : "2013-09-02 10:22:54", // shipping time (can be null) - datetime
    "referenceType" : "Order", // reference type, can be "Order", "Quote", "Invoice", "ShippingInvoice", "Proforma", "CreditNote", "Receipt" or "PackingSlip" (can be null) - string
    "referenceNumber" : "2013/30991", // reference number - string(0…32)
    "customer" : 37091, // customer (id) (can be null) - int(1…)
    "rounding" : { // rounding
      "mode" : "HalfUp",  // mode, can be "Down", "HalfDown", "HalfEven" or "HalfUp" - string
      "rule" : "PerItem"  // rule, can be "PerItem", "PerLine" or "Total" - string
    },
    "locale" : "en-GB", // locale (ISO code) of the customer, region is not mandatory - string(2…5)
    "items" : [ { // items
      "sku" : "A927TP", // SKU - string(0…32)
      "name" : "Shirt", // name - string(0…255)
      "quantity" : 3.00, // quantity - decimal[8,2](0…)
      "price" : 56.330, // price (excluded taxes) - decimal[10,3]
      "weight" : 0.450, // weight - decimal[8,3](0…)
      "taxClass" : 2, // tax class (id) (can be null) - int(1…)
      "requests" : "…" // customer requests - string(0…255)
    }, … ],
    "discounts" : [ { // discounts, up to 5
      "type" : "PercentOff", // type, can be "PercentOff" or "AmountOff" - string
      "value" : 20.000 // value, must be greater than zero and if percentage must be less than or equal to 100 - decimal[8,3](0…)
    }, {
      "type" : "AmountOff",
      "value" : 10.450
    }, … ],
    "discountsIncludeTaxes" : false, // indicates if discounts include taxes - bool
    "shippingMethod" : 3, // shipping method (id) (can be null) - int(0…)
    "shippingCost" : 8.572, // shipping cost, if null it is calculated by the shipping method (can be null) - decimal[8,3](0…)
    "paymentMethod" : 8, // payment method (id) (can be null) - int(0…)
    "paymentCost" : 1.200 // payment cost, if null it is calculated by the payment method (can be null) - decimal[8,3](0…)
    "billingAddress" : { // billing address (required)
      "firstName" : "Sherlock", // first name (required) - string(1…25)
      "lastName" : "Holmes", // last name (required) - string(1…25)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "companyCode2" : "7J BA3 006", // second company code number - string(0…20)
      "street1" : "221b Baker Street", // street, first row (required) - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city  (required) - string(1…25)
      "postalCode" : "NW1 6XE", // postal code (required) - string(1…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) (required) - string(2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address (required) - string(3…120)    },
    "shippingAddress" : { // shipping address (can be null)
      "name" : "John", // recipient name (required) - string(1…100)
      "street1" : "221b Baker Street", // street, first row (required) - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city (required) - string(1…25)
      "postalCode" : "NW1 6XE", // postal code (required) - string(1…20)
      "stateProv" : "LND", // province, state or county - string(0…3)
      "country" : "GB" // country (ISO code) (required) - string(2)    },
    "sellerAddress" : { // seller address
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "street1" : "221b Baker Street", // street, first row - string(0…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(0…25)
      "postalCode" : "NW1 6XE", // postal code - string(0…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) - string(0…2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address - string(0…120)    },
    "numberOfPackages" : 1, // number of packages - int(1…100)
    "porto" : "Franco", // porto, can be "Franco" or "Assegnato" (can be null) - string
    "goodsAppearance" : "Five cardboard boxes", // goods appearance - string(0…255)
    "trackingNumber" : "rt-5pl7f-fg", // tracking number - string(0…64)
    "transportReason" : "Order shipment", // transport reason - string(0…255)
    "terms" : "" // terms and conditions - string(0…65535)
  }
}

Response

{
  "status" : "ok",
  "id" : 662705500 // identifier of the new packing slip - int(1…)
}

Errors

Field	Type	Description
country	InvalidValue	No tax areas for country '`<country>`'
country	MissingCombination	Country of seller address is required if 'stateProv' is provided
creationTime	InvalidValue	Creation time '`<creationTime>`' is in the future
customer	NotFound	Customer `<customer>` does not exist
discounts	InvalidValue	Amount off discount can not be applied to a zero subtotal
discounts	Malformed	There can be no more than 5 discounts
locale	Malformed	'`<locale>`' is not a valid locale code
paymentMethod	InvalidCombination	Payment method is required if payment cost is provided
paymentMethod	InvalidValue	No payment methods can be used if total is zero or negative
paymentMethod	InvalidValue	Payment method `<paymentMethod>` can not be used in combination with shipping method `<shippingMethod>`
paymentMethod	InvalidValue	Payment method `<paymentMethod>` is not suitable for this packing slip
paymentMethod	NotFound	Payment method `<paymentMethod>` does not exist
shippingMethod	InvalidCombination	Shipping method is required if shipping cost is provided
shippingMethod	InvalidValue	Shipping method `<shippingMethod>` is not suitable for this packing slip
shippingMethod	MissingCombination	Shipping method is required because the payment method is on delivery
shippingMethod	NotFound	Shipping method `<shippingMethod>` does not exist
taxClass	NotFound	Tax class `<taxClass>` does not exist

Notes

Per i nuovi documenti di trasporto non indicare number e creationTime, prenderanno automaticamente il prossimo numero d'ordine e la data corrente.
Non indicare rounding se si vuole utilizzare l'impostazione globale.
Non indicare taxArea se si vuole che venga determinata automaticamente in base agli indirizzi di fatturazione e spedizione.

packing-slips.update

Updates a packing slip. Any fields left out of the request will remain unchanged.

Request

Admin SDK
Admin.api('commerce.packing-slips.update', request, function(response) { … });

HTTP POST
/api/v6/commerce.packing-slips.update

{
  "id" : 662705500, // identifier of the packing slip to update (required)
  "packingSlip" : { // packing slip's fields to update (required)
    "number" : "2013/90471", // number - string(0…32)
    "status" : "Open", // status, can be "Open", "Shipped" or "Cancelled"
    "creationTime" : "2013-09-01 12:00:00", // creation time, if empty it takes the current time - datetime
    "shippingTime" : "2013-09-02 10:22:54", // shipping time (can be null) - datetime
    "referenceType" : "Order", // reference type, can be "Order", "Quote", "Invoice", "ShippingInvoice", "Proforma", "CreditNote", "Receipt" or "PackingSlip" (can be null) - string
    "referenceNumber" : "2013/30991", // reference number - string(0…32)
    "customer" : 37091, // customer (id) (can be null) - int(1…)
    "rounding" : { // rounding
      "mode" : "HalfUp",  // mode, can be "Down", "HalfDown", "HalfEven" or "HalfUp" - string
      "rule" : "PerItem"  // rule, can be "PerItem", "PerLine" or "Total" - string
    },
    "locale" : "en-GB", // locale (ISO code) of the customer, region is not mandatory - string(2…5)
    "items" : [ { // items
      "sku" : "A927TP", // SKU - string(0…32)
      "name" : "Shirt", // name - string(0…255)
      "quantity" : 3.00, // quantity - decimal[8,2](0…)
      "price" : 56.330, // price (excluded taxes) - decimal[10,3]
      "weight" : 0.450, // weight - decimal[8,3](0…)
      "taxClass" : 2, // tax class (id) (can be null) - int(1…)
      "requests" : "…" // customer requests - string(0…255)
    }, … ],
    "discounts" : [ { // discounts, up to 5
      "type" : "PercentOff", // type, can be "PercentOff" or "AmountOff" - string
      "value" : 20.000 // value, must be greater than zero and if percentage must be less than or equal to 100 - decimal[8,3](0…)
    }, {
      "type" : "AmountOff",
      "value" : 10.450
    }, … ],
    "shippingMethod" : 3, // shipping method (id) (can be null) - int(0…)
    "shippingCost" : 8.572, // shipping cost, if null it is calculated by the shipping method (can be null) - decimal[8,3](0…)
    "paymentMethod" : 8, // payment method (id) (can be null) - int(0…)
    "paymentCost" : 1.200 // payment cost, if null it is calculated by the payment method (can be null) - decimal[8,3](0…)
    "billingAddress" : { // billing address
      "firstName" : "Sherlock", // first name (required) - string(1…25)
      "lastName" : "Holmes", // last name (required) - string(1…25)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "companyCode2" : "7J BA3 006", // second company code number - string(0…20)
      "street1" : "221b Baker Street", // street, first row (required) - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city  (required) - string(1…25)
      "postalCode" : "NW1 6XE", // postal code (required) - string(1…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) (required) - string(2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address (required) - string(3…120)    },
    "shippingAddress" : { // shipping address (can be null)
      "name" : "John", // recipient name (required) - string(1…100)
      "street1" : "221b Baker Street", // street, first row (required) - string(1…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city (required) - string(1…25)
      "postalCode" : "NW1 6XE", // postal code (required) - string(1…20)
      "stateProv" : "LND", // province, state or county - string(0…3)
      "country" : "GB" // country (ISO code) (required) - string(2)    },
    "sellerAddress" : { // seller address
      "companyName" : "Investigations Inc", // company name - string(0…100)
      "companyCode" : "INV8403MC1", // company code number - string(0…20)
      "personalCode" : "SH239IBA", // personal code - string(0…20)
      "street1" : "221b Baker Street", // street, first row - string(0…60)
      "street2" : "", // street, second row - string(0…60)
      "city" : "London", // city - string(0…25)
      "postalCode" : "NW1 6XE", // postal code - string(0…20)
      "stateProv" : "LND", // state, province or county - string(0…3)
      "country" : "GB", // country (ISO code) - string(0…2)
      "phoneNumber" : "+44+207 2243688", // phone number - string(0…15)
      "mobileNumber" : "", // mobile number - string(0…15)
      "faxNumber" : "", // fax number - string(0…15)
      "email" : "holmes@inv-london.com" // email address - string(0…120)    },
    "numberOfPackages" : 1, // number of packages - int(1…100)
    "porto" : "Franco", // porto, can be "Franco" or "Assegnato" (can be null) - string
    "goodsAppearance" : "Five cardboard boxes", // goods appearance - string(0…255)
    "trackingNumber" : "rt-5pl7f-fg", // tracking number - string(0…64)
    "transportReason" : "Order shipment", // transport reason - string(0…255)
    "terms" : "" // terms and conditions - string(0…65535)
  }
}

Response

{
  "status" : "ok"
}

Errors

Field	Type	Description
country	InvalidValue	No tax areas for country '`<country>`'
country	MissingCombination	Country of seller address is required if 'stateProv' is provided
creationTime	InvalidValue	Creation time '`<creationTime>`' is in the future
customer	NotFound	Customer `<customer>` does not exist
discounts	InvalidValue	Amount off discount can not be applied to a zero subtotal
discounts	Malformed	There can be no more than 5 discounts
id	NotFound	Packing slip `<id>` does not exist
items	Malformed	An item id is repeated
items	NotFound	Packing slip `<id>` does not have item `<id>`
locale	Malformed	'`<locale>`' is not a valid locale code
paymentCost	InvalidValue	Packing slip `<id>` has not a payment method
paymentMethod	InvalidValue	No payment methods can be used if total is zero or negative
paymentMethod	InvalidValue	Payment method `<paymentMethod>` can not be used in combination with shipping method `<shippingMethod>`
paymentMethod	InvalidValue	Payment method `<paymentMethod>` is not suitable for this packing slip
paymentMethod	NotFound	Payment method `<paymentMethod>` does not exist
shippingCost	InvalidValue	Packing slip `<id>` has not a shipping method
shippingMethod	InvalidValue	Shipping method `<shippingMethod>` is not suitable for this packing slip
shippingMethod	MissingCombination	Shipping method is required because the payment method is on delivery
shippingMethod	NotFound	Shipping method `<shippingMethod>` does not exist
taxClass	NotFound	Tax class `<taxClass>` does not exist

packing-slips.delete

Deletes one or more packing slips.

Request

Admin SDK
Admin.api('commerce.packing-slips.delete', request, function(response) { … });

HTTP POST
/api/v6/commerce.packing-slips.delete

{
  "ids" : [ 662705500, … ] // identifiers of the packing slips to delete (required) - int(1…)
}

Response

{
  "status" : "ok"
}

Quanto ti è stata utile questa pagina?

Grazie per averci aiutato a migliorare questa pagina