Date Version Changes
2017-11-22 1.9.0
  • Added the barcode property to Products that grants users the option to specify existing physical barcodes on their products. The default barcode is the product ID when none is provided. Existing products will inherit the warehouse barcode settings.
2017-11-15 1.8.15
2017-10-09 1.8.14
  • Added signature_confirmation to Orders.
2017-08-02 1.8.13-beta
  • Added ability to print product barcodes for inbounding at BoxC warehouses.
  • Added ability to bulk print up to 100 product barcodes.
  • Added dimensions property to Products for bulk printing.
  • Added error code 1337.
  • Added error code 1220.
2017-07-31 1.8.12-beta
  • Added optional carrier and tracking_number properties to the Manifests resource for monitoring inbound deliveries of shipments to BoxC warehouses.
2017-07-14 1.8.11-beta
  • Added packing_slip to the Orders resource.
  • Added packaging_fee and packing_slip_fee to Orders.fulfillments.
2017-05-03 1.8.10-beta
  • shop.id is no longer required when searching for product SKUs.
2017-04-12 1.8.9-beta
  • Added the notes property to the Inbound resource.
  • Made an inbound object's carrier and tracking_number properties optional (default: null).
2017-04-03 1.8.8-beta
  • Added the ability to override address verification for some services using the override property in the Orders resource.
2017-03-20 1.8.7-beta
  • Added a new status, "Holding", to Orders. This status can be set by the user to prevent an order from being processed by the system. The user can remove the holding status by updating the status property to "Processing".
  • The Orders status property may now be changed to "Holding" or "Processing".
2017-03-17 1.8.6-beta
  • Added two new Dangerous Goods: 0965, 0968.
  • Added signature_confirmation to Shipments.
  • Added signature_confirmation as a query parameter to Estimate.
2017-03-12 1.8.5-beta
  • Added fulfillment_id to line_items in the Orders resource.
2017-03-09 1.8.4-beta
  • Added service to the Orders resource. It defaults to "BoxC" and behaves like Shipments where some services are not available for select routes.
  • Shipments now accepts other countries in the shipping address other than "US" for select entry points starting with SZXI01. The return address still requires an address in the US. Parcels to the rest of the world use a return address provided by a third party until further notice.
2017-02-24 1.8.3-beta
  • Changed the id for Labels to be a system assigned integer so it's no longer the same as the tracking_number. Both the id and tracking_number are interchangeable in the URI.
2017-02-20 1.8.2-beta
  • Orders may now be searched using the shipping_address.name query parameter.
2017-02-09 1.8.1-beta
  • Added pagination to Shops and the ability to search by shop name.
2017-01-10 1.8.0-beta
  • Dangerous Goods
    • Added dg_code to the Shipments resource. This property is used to indicate a shipment contains a permitted dangerous good thus limiting the services and routes a shipment may use. There are no additional fees.
    • Added dg_code to the Products resource.
    • Added dg_code to orders' line_items. This value is inherited from the corresponding product.
    • The Estimate resource now accepts one or more dg_code parameters and will only return services that allow the requested dangerous goods.
  • Product Descriptions
    • A product must now have a description in the local language for each warehouse it's held at. For example, if a product is stored in Shenzhen, China it must have a description in Chinese in addition to its default description. If multiple warehouses have the same local language then updates to the product description will propagate to all warehouses with the same language_code.
    • Users must use the local_descriptions property to modify product descriptions in different languages.
    • Added language and language_code (ISO 639-1) to the Warehouses resource.
    • Added description and language to the warehouses property for Products. This is the description of the product in the warehouse's local language.
    • Added language and language_code to the warehouse property for Inbound shipments.
  • Added coo and hs_code to the Products resource.
  • Add a new status to the Orders resource: Exception. If there's a problem with the order then its status will change to "Exception". The user must correct the problem before it can be processed again.
  • Added address verification for Orders destined to the US.
  • Added email to the shipping address for Orders and Shipments.
  • Removed error codes: 1051, 1202.
  • Added new error code: 1012.
2016-12-08 1.7.6-beta
  • Added new error code: 1144.
2016-11-30 1.7.5-beta
  • Removed oversize_fee from the top level of the Estimate resource and added it to each service. Each shipping method's total_cost now includes the oversize fee for that service if applicable.
  • Updated error code 1051 to be more descriptive.
2016-11-07 1.7.4-beta
  • Added the ability to search for Manifests.
  • Products can now be sorted by quantity.
2016-10-10 1.7.3-beta
  • Added the ability to search for shipments by the recipient's name.
  • Added the ability to search for shipments by the overpack_id.
  • Added the ability to search for shipments by checking each item in comments.
2016-09-26 1.7.2-beta
  • Added shipping_methods to the Estimate resource for each service. By default all services have a "Standard" shipping method and an empty string for the corresponding code. Some routes may have additional shipping methods and non-empty codes. The code can be used to select the shipping method while creating shipments.
  • Deprecated the root total_cost property for estimates.
  • Added the shipping_method property to the Shipments resource. By default all shipments will be created using the "Standard" shipping method for the given service which is represented by an empty string.
  • Updated error code: 1202.
  • Added new tracking event code: 319.
2016-09-06 1.7.1-beta
  • Added the backordered property to Products. This number indicates the total backordered quantity for a given product.
  • The new Returns resources are now generally available.
  • Products search method can now be sorted by id, name, or backordered.
  • Added new error code: 1336.
2016-08-23 1.7.0-beta
  • Added Subscriptions to the Users resource. Currently, only BoxC owned applications can create subscriptions. Subscriptions will appear as a separate Charge on users' invoices.
  • Added a preview of the Returns component to the API which includes two new resources: The new resources will be generally available in a future update.
  • Only users with a subscription to Returns By BoxC will have their returned shipments processed. They will also be able to verify and reship packages.
  • Returns processing and reshipping fees will be deducted from account balances and appear on users' invoices under a Returns section.
  • Verifying returns will appear as a separate Charge on users' invoices.
  • Added new error codes: 1100, 1101, 1102, 1103, 1104, 1120, 1121, 1122, 1140, 1141, 1142, 1143.
2016-07-28 1.6.4-beta
  • Added the delay_processing field to the Shop's settings property. The default value is 0 for existing shops.
2016-07-21 1.6.3-beta
  • Added the code property to the events array for Labels.
  • Added a list of descriptions that will be encountered while retrieving a label's tracking history. See the Tracking Events page for further details.
2016-07-19 1.6.2-beta
  • Added ability to search for Products by name or SKU.
  • Added new error codes: 1030, 1204, 1219.
2016-06-24 1.6.1-beta
  • Added the Exceptions resource.
  • Added new error code: 1230.
2016-06-07 1.6.0-beta
  • OAuth and Access Tokens
    • The access token creation and verification logic was changed internally, but the authorization flow remains the same. All tokens will be permanently deleted on Tuesday, June 7 at 12:00pm EDT. This means users will need to reauthorize your application in order to use the API again.
    • Added a DELETE method to the OAuth resource for revoking access tokens.
  • Fulfillment Service
    • Various resources for the fulfillment service are now available for production purposes. The API can be used to perform CRUD on orders, products, shops, inbound shipments, and warehouses.
    • A new web application for fulfillment is available at https://fulfillment.boxc.com. The current application (fbb.boxc.com) will be taken offline after existing users are transitioned to the new website. Users must add their products and shops to the new web application - or via the API directly - to prevent service disruption.
2016-05-11 1.5.17-beta
  • Added id to the label and labels properties for the Shipments resource. In most cases the id is the same as the label's tracking_number.
  • Added label_id to the shipments property for the Overpacks resource. In most cases the label_id is the same as the tracking_number.
2016-04-18 1.5.16-beta
  • Added service property to the Overpacks resource. Defaults to "BoxC". All current overpacks were changed to "BoxC".
  • Shipments must be sorted by service when placing them in overpacks. The system will return an error if you attempt to add a shipment to an overpack that doesn't have the same service.
  • Limited the number of labels that can be printed to 100 while using POST /labels/bulk.
  • Updated error code 1217 to: "Shipment and overpack must use the same service".
  • Increased maximum search limit for Invoices to 100.
2016-04-04 1.5.15-beta
  • Added the Entry Points resource.
2016-03-19 1.5.14-beta
  • Changed the naming convention for Entry Points. Older entry points are deprecated and aliased to automatically change to the new ones. Applications should make updates to use the new entry point codes.
2016-03-05 1.5.13-beta
  • Added return_address to Users resource so users can set their default return address using the API. Only the return_address.name is required.
  • The from property for Shipments is now optional. It will inherit the user's return address setting if not provided. If the user's default return address isn't set then it will use a return address belonging to BoxC.
2016-02-24 1.5.12-beta
  • Removed the authorized_apps property from Users resource.
2016-02-09 1.5.11-beta
  • Added the processed_weight property to Labels.
  • The cost for Labels represents the corrected/invoiced cost of the label if processed.
  • The total_cost for Shipments uses the sum of the corrected/billed cost if processed, or the original cost if not processed.
2016-01-31 1.5.10-beta
  • Added the labeled search parameter to Shipments.
  • Added the packed search parameter to Shipments.
2016-01-30 1.5.9-beta
  • Removed the barcode property from Labels.
2016-01-18 1.5.8-beta
  • Added the XLS file type for downloading Invoices.
  • Removed the file property from Invoices.
  • Added actual_weight to the Invoice file. This is not retroactive.
2015-12-27 1.5.7-beta
  • Added a consignor property to the Shipments resource that's used for Customs. It inherits the user's company address and phone number if it's not provided.
  • Company address is now required before creating shipments in addition to overpacks.
2015-12-16 1.5.6-beta
  • Increased the max length of contents to 255 for Shipments.
2015-12-11 1.5.5-beta
  • Increased the default search history to 90 days past for Shipments.
  • Increased the default search history to 90 days past for Overpacks.
2015-11-29 1.5.4-beta
  • Updated Invoices resource to no longer include date_start and date_end properties. Invoices can potentially be created every day if necessary.
  • Added created property to Invoices.
2015-11-27 1.5.3-beta
  • Removed error code 1207.
  • Reversed user balances so that outstanding balances appear as a negative number and users that added funds to their account will have a positive balance that decreases rather than increases.
2015-11-17 1.5.2-beta
  • Changed SHCN to SHCN1 as an entry_point and made it available as an option.
  • Added quantity property to Shipments.
2015-11-05 1.5.1-beta
  • Added another size option when creating Labels: 4x4 inches. The default size remains at 4x6.
  • Changed default value of create_label to false.
  • Retrieving a single overpack now returns all shipments - even those without labels.
2015-10-23 1.5.0-beta
  • Added the ability to choose a shipping service: BoxC or BoxC Plus. Both have different rates and transit times.
  • Added service property to Shipments. It defaults to BoxC.
  • Updated Estimate resource to display services and transit times.
  • Added service property to Labels output. This is inherited from the Shipment at the time of creation.
2015-10-22 1.4.2-beta
  • Added a new resource for Invoices that allows a user to retrieve all debits and credits every 2 weeks.
  • The Shipments' and Overpacks' created property is no longer incorrectly changed when updates to objects occur.
  • Added new error code: 1090.
2015-10-15 1.4.1-beta
  • Added an option called create_label to the Shipments resource that allows the user to create a label automatically when creating or updating a shipment. Default value is true.
  • Added new error codes: 1207, 1217.
2015-10-12 1.4.0-beta
  • Refactored the Manifests resource so it's now a persistent object. As a result, the actions have changed considerably.
  • Changed some wording for the error codes pertaining to Manifests.
  • Added a new error code: 1275.
2015-10-08 1.3.2-beta
  • Added the ability to provide a custom return address to the Shipments resource. If one isn't provided, the system will use a default return address belonging to BoxC.
2015-10-04 1.3.1-beta
  • Overpacks resource now returns shipment IDs and their tracking numbers for single overpack retrieval.
  • You can now pass null to PUT Labels in order to remove shipments from overpacks.
  • phone is now optional.
  • Reduced override fee to $0.
  • Added new error codes: 1273, 1274.
2015-09-27 1.3.0-beta
  • Changed Labels resource so that only PDF can be downloaded.
  • Reduced the label file size 95%.
  • Added a bulk PDF download action to the Labels resource.
2015-09-15 1.2.2-beta
  • Added events property to Labels resource that displays tracking history for the label.
  • Changed the Shipments search response to only include one uncancelled label for each shipment.
2015-09-13 1.2.1-beta
  • Added new action for easily assigning shipments to overpacks by scanning labels: PUT /labels/{id}.
  • Removed the ability from Overpacks resource to add shipments to overpacks in bulk.
2015-09-10 1.2.0-beta
  • Added the Manifests resource.
  • Added new error codes to reflect the changes: 1251, 1270, 1271, 1272.
  • Added HTTP Basic Authentication for users who wish to access resources with a browser.
  • Added locked property to Overpacks.
2015-09-01 1.1.1-beta
  • Added paginated list retrieval for Overpacks.
  • Added total_shipments and total_pages to Shipments' paginated list retrieval.
  • Refactored Overpack labels to be a 4x6 label in PDF.
  • Added address check for Users when operating on Overpacks: error code 1015.
2015-08-25 1.1.0-beta
  • Added Overpacks resource.
  • Added Users resource.
  • Added phone to Shipments:to property.
  • Added hs_code to Shipments for item values greater than $800 USD.
  • Added coo to Shipments for country of origin. Defaults to "CN".
  • Changed origin to entry_point. We're now using codes for entry points instead of cities and countries. The Estimate and Shipments resources were updated to reflect the changes.
  • Added entry points for Hong Kong and Guangzhou, China.
  • Added new error codes to reflect the changes: 1213, 1214, 1215, 1216, 1250.
2015-08-01 1.0.1-beta
  • Added origin property to Shipments. The origin includes a city and country code that represent the drop off location (and base rates) for created shipments. Only Shanghai, CN and Shenzhen, CN are supported. The default origin settings can be changed in your application's management console. You can override the default origin settings when creating a shipment.
2015-06-01 1.0.0-beta First version for testing. Revisions and bug fixes will be added regularly.