Changelog v0.0.34
(2020-07-30)
Overall Changes
- HTML label format is no longer supported
- Removed geo-coordinates from all Address properties
- Removed support for Localization
- Updated CLI namespace. You should uninstall the old one before the latest version.
npm uninstall @shipengine/cli -gnpm install @shipengine/integration-platform-cli -g
- CLI commands are no longer prefaced with
apps:
. The documentation has been updated. - The
shipengine test
command has changed. We are in the process of updating the documentation for this.
Carrier App
These changes affect the Carrier App.
Carrier App Definition
- Added an
icon
property similar to the logo property. - Added a
manifestType
property.
createShipment() Method
Parameter: NewShipment
Removed properties:
outboundShipment
packages.contents.quantity.unit
Added properties:
deliveryService.supportsReturns
Changes:
packages.customs.contents.unitValue.value
- now a number rather than a stringpackages.customs.contents.unitValue.currency
- now accepts any string rather than an enum valuepackages.customs.contents.totalValue.value
- now a number rather than a stringpackages.customs.contents.totalValue.currency
- now accepts any string rather than an enum valuepackages.contents.unitPrice.value
- now a number rather than a stringpackages.contents.unitPrice.currency
- now accepts any string rather than an enum valuepackages.contents.totalPrice.value
- now a number rather than a stringpackages.contents.totalPrice.currency
- now accepts any string rather than an enum value
Return Value: ShipmentConfirmation
Removed properties:
deliveryWindow
fulfillmentService
zone
isGuarnteed
isNegotiatedRate
minimumDeliveryDays
maximumDeliveryDays
metadata
trackingURL
packages.trackingURL
packages.documents
packages.label
packages.customForm
billing
charges.code
charges.description
charges.notes
packages.customs.contents.unitValue.unit
packages.customs.contents.totalValue.unit
Added properties: (moved from the packages property up a level)
documents
label
customsForm
Changes:
packages.insuredValue.value
- now a number rather than a stringpackages.insuredValue.currency
- now accepts any string rather than an enum valuecharges.amount.value
- now accepts a number rather than a stringcharges.amount.value.currency
- now accepts any string rather than an enum value
rateShipment() Method
Parameter: RateCriteria
Removed properties:
outboundShipment
deliveryWindow
fulfillmentService
zone
isGuaranteed
minimumDeliveryDays
maximumDeliveryDays
Added properties:
deliveryService.supportsReturns
deliveryService.manifestType
Changes:
- Renamed
deliveryServices
todeliveryService
and changed it from an array to a single object - Renamed
fulfillmentServices
tofulfillmentService
and changed it from an array to a single object totalInsuredValue.value
- now a number rather than a stringtotalInsuredValue.currency
- now accepts any string rather than an enum value
Return Value: Rate
Removed properties:
charges.code
charges.description
charges.notes
Added properties:
deliveryService.supportsReturns
deliveryService.manifestType
Changes:
charges.amount.value
- now accepts a number rather than a stringcharges.amount.value.currency
- now accepts any string rather than an enum valuedeliveryService
now acceptes an object or a string containing thecode
.
trackShipment()
Return Value: TrackingInfo
Added properties:
packages[].packaging.deliveryService.supportsReturns
packages[].packaging.deliveryService.manifestType
Changes:
packages[].packaging
now acceptes an object or a string containing thecode
.
schedulePickup()
Parameter: PickupRequest
Added properties:
pickupService.shipments[].deliveryService.supportsReturns
pickupService.shipments[].deliveryService.manifestType
Removed properties:
contact.phoneExtension
Return Value: PickupConfirmation
Removed properties:
charges.code
charges.description
charges.notes
Changes:
charges.amount.value
- now accepts a number rather than a stringcharges.amount.value.currency
- now accepts any string rather than an enum value
cancelPickup()
Parameter: PickupCancellation
Added properties:
shipments[].deliveryService.supportsReturns
shipments[].deliveryService.manifestType
Removed properties:
contact.phoneExtension
Definition Changes
- Added
supportsReturns
property. - Added
manifestType
property. - Added
code
property.
- Added
code
property.
- Added
code
property.
- Added
code
property.
Order App
These changes affect the Order App.
Order App Definition
Added an icon property similar to the logo property.
getSalesOrdersByDate()
Parameter: SalesOrderTimeRange
Added properties:
paging
paging.pageSize
paging.pageNumber
paging.pageCount
paging.cursor
Return Value: SalesOrderArray
(Previously returned <Iterable>SalesOrder
)
Removed properties:
fulfillmentStatus
paymentStatus
seller
charges.code
charges.description
charges.notes
totalCharges.code
totalCharges.description
totalCharges.notes
buyer.identifiers
buyer.phoneExtension
items.quantity.unit
Added properties:
paging
paging.pageSize
paging.pageNumber
paging.pageCount
paging.cursor
buyer.address
(optional)
Changes:
charges.amount.value
- now accepts a number rather than a stringcharges.amount.value.currency
- now accepts any string rather than an enum valuetotalCharges.amount.value
- now accepts a number rather than a stringtotalCharges.amount.value.currency
- now accepts any string rather than an enum valueshippingPreferences.insuredValue.value
- now accepts a number rather than a stringshippingPreferences.insuredValue.currency
- now accepts any string rather than an enum value
shipmentCreated()
Parameter: SalesOrderShipment
Removed properties:
deliveryDateTime
minimumDeliveryDays
maximumDeliveryDays
deliveryWindow
packages
items.fulfillmentStatus
items.trackingURL
items.shippingPreferences
items.charges
items.totalAmount
items.totalCharges
Added properties:
contents
(moved from packages up a level)contents.salesOrder
contents.salesOrder.id
contents.salesOrder.identifiers
contents.salesOrderItem
contents.salesOrderItem.id
contents.salesOrderItem.sku
contents.salesOrderItem.identifiers
contents.product
contents.product.id
contents.product.sku
contents.product.identifiers
contents.quantity
contents.quantity.value
items.thumbnailURL
Changes:
items.product
is now requiredfulfillmentStatus
now accepts a string instead of an enum
shipmentCancelled()
Parameter: SalesOrderShipment
Removed properties:
deliveryDateTime
minimumDeliveryDays
maximumDeliveryDays
deliveryWindow
packages
items.fulfillmentStatus
items.trackingURL
items.shippingPreferences
items.charges
items.totalAmount
items.totalCharges
Added properties:
contents
(moved from packages up a level)contents.salesOrder
contents.salesOrder.id
contents.salesOrder.identifiers
contents.salesOrderItem
contents.salesOrderItem.id
contents.salesOrderItem.sku
contents.salesOrderItem.identifiers
contents.product
contents.product.id
contents.product.sku
contents.product.identifiers
contents.quantity
contents.quantity.value
items.thumbnailURL
Changes:
items.product
is now requiredfulfillmentStatus
now accepts a string instead of an enum
getSalesOrder() Method
No longer supported.
getSeller() Method
No longer supported.