V3 - 10/18/2021

This change added a new attribute to an existing JSON object.

Modified JSON Objects

V2 - 03/30/2020

Although these V2 APIs have been deprecated in favor of the new V3 APIs, we have responded to an urgent partner request and added the following attributes to the OrderStatus object, allowing these attributes to be returned from the Find Order Statuses API.


Modified JSON Objects

  • OrderStatus
    • Added dscoRetailerId
    • Added dscoSupplierId
    • Added dscoTradingPartnerId
    • Added dscoTradingPartnerName
    • Added requestedWarehouseCode
    • Added requestedWarehouseRetailerCode
    • Added requestedWarehouseDscoId
    • Added dscoWarehouseCode
    • Added dscoWarehouseRetailerCode
    • Added dscoWarehouseDscoId
    • Added shipWarehouseCode
    • Added shipWarehouseRetailerCode
    • Added shipWarehouseDscoId

V2 - 4/11/2019

This change involves adding productStatus to an item and creating a better status on orders, called dscoLifecycle.

Modified JSON Objects

  • ItemInventory
    • Added productStatus
  • Order
    • Added dscoLifecycle
  • OrderStatus
    • Added dscoLifecycle
  • Shipment
    • Added dscoOrderLifecycle

V2 - 12/3/2018

This change is not backward compatible. It removes the concept of a "master" assortment from the system. Dsco performed analysis and did not find any customers using this feature and so deemed it safe to remove it.

Modified JSON Objects

  • Assortment JSON Object

V2 - October 2018

This change is completely backward compatible and simply adds new APIs.

New APIs

  • UpdateOrderEstimatedShipDate

New JSON Objects

  • OrderEstimatedShipDateLineItem

V2 - August 2018

This change is completely backward compatible and simply adds new attributes to existing JSON object.

Modified JSON Objects

  • Invoice
    • These attributes were erroneously placed on this object in the previous release and were removed; see the "ship" attribute of invoice where they were moved to (the InvoiceShip object below where they belong)
    • Removed warehouseCode
    • Removed warehouseRetailerCode
    • Removed warehouseDscoId
    • Removed ssccBarcode
  • InvoiceShipInfo
    • Added warehouseCode
    • Added warehouseRetailerCode
    • Added warehouseDscoId
    • Added ssccBarcode
  • Package
    • These attributes were erroneously placed on this object in the previous release and have been removed
    • Removed requestedWarehouseCode
    • Removed requestedWarehouseRetailerCode
    • Removed requestedWarehouseDscoId
  • Shipment
    • Added dscoWarehouseCode
    • Added dscoWarehouseRetailerCode
    • Added dscoWarehouseDscoId
    • Added requestedWarehouseCode
    • Added requestedWarehouseRetailerCode
    • Added requestedWarehouseDscoId
    • Added shipWarehouseCode
    • Added shipWarehouseRetailerCode
    • Added shipWarehouseDscoId

V2 - 6/28/2018

This change is completely backward compatible and simply adds new attributes to existing JSON object.

Modified JSON Objects

  • Invoice
    • Added warehouseCode
    • Added warehouseRetailerCode
    • Added warehouseDscoId
    • Added ssccBarcode
    • Added requestedWarehouseCode
    • Added requestedWarehouseRetailerCode
    • Added requestedWarehouseDscoId
  • InvoiceLineItem
    • Added warehouseCode
    • Added warehouseRetailerCode
    • Added warehouseDscoId
    • Added retailerItemIds
    • Added departmentId
    • Added departmentName
    • Added merchandisingAccountId
    • Added merchandisingAccountName
    • Added dscoOriginalOrderRetailerCreateDate
    • Added ssccBarcode
    • Added requestedWarehouseCode
    • Added requestedWarehouseRetailerCode
    • Added requestedWarehouseDscoId
  • ItemWarehouse
    • Added dscoId
    • Added retailerCode
  • Order
    • Added requestedWarehouseCode
    • Added requestedWarehouseRetailerCode
    • Added requestedWarehouseDscoId
    • Added dscoWarehouseCode
    • Added dscoWarehouseRetailerCode
    • Added dscoWarehouseDscoId
    • Added shipWarehouseCode
    • Added shipWarehouseRetailerCode
    • Added shipWarehouseDscoId
    • Documented packingSlipMessage (attribute was missing - doc bug)
  • OrderLineItem
    • Added warehouseDscoId
    • Added warehouseRetailerCode
    • Added retailerItemIds
    • Added departmentId
    • Added departmentName
    • Added merchandisingAccountId
    • Added merchandisingAccountName
  • Package
    • Added warehouseCode
    • Added warehouseRetailerCode
    • Added warehouseDscoId
    • Added ssccBarcode
    • Added requestedWarehouseCode
    • Added requestedWarehouseRetailerCode
    • Added requestedWarehouseDscoId
  • PackageLineItem
    • Added retailerItemIds
    • Added departmentId
    • Added departmentName
    • Added merchandisingAccountId
    • Added merchandisingAccountName

V2 - 5/7/2018

This change is completely backward compatible and simply adds functionality to existing APIs.

Modified APIs

  • findItemInventory
    • added compress attribute
      • If true, compresses the result into a new attribute in the result object. The PagedItemInventoryResult JSON Object has instructions on decoding the result if you turn compression on.
    • omitItemsOnHold
      • If the account calling the API is a retailer, don't include items associated with a supplier when the supplier is on hold (is in on-boarding) - defaults to true, which is a  possibly non-backward compatible change to the data returned
    • clearQuantityForStoppedItems
      • If the account calling the API is a retailer, set the availableQuantity to 0 and the status to out-of-stock for all items associated with suppliers that are currently stopped, which is a  possibly non-backward compatible change to the data returned
    • increased number of returned results
      • The number of results returned with each page is increased.
    • fastMode irrelevant
      • The API was re-written to be faster regardless of whether this mode is used or not.

Modified JSON Objects

  • PagedItemInventoryResult
    • added base64EncodedCompressedItemInventory attribute
      • This attribute will contain the compressed results as a string if the API specified the results should be compressed.
    • scrollId
      • May be used instead of lastId to get the next page of results and will be the only way to get the next page of results sometime in 2019 as lastId has been deprecated.
    • deprecated pageNum, pageSize, pageCount, lastId
      • These attributes will be removed sometime in early 2019.

V2 - 3/22/2018

This change is completely backward compatible and simply adds functionality to existing APIs.

New APIs

  • Find Webhook History API

New JSON Objects

  • PagedWebhookHistoryResult JSON Object
  • WebhookHistory JSON Object

V2 - 3/7/2018

This change is completely backward compatible and simply adds functionality to existing APIs.

Modified Feature

  • A new webhook type is now supported, ORDER_LINE_ITEM_STATUS_UPDATED.

Modified JSON Objects

  • Order JSON Object
    • Added packages attribute which for now which will only be populated on Order objects sent as webhooks but will not be populated on Order objects returned from API calls
  • Webhook JSON Object
    • Added ORDER_LINE_ITEM_STATUS_UPDATED to event enumeration
  • WebhookEvent JSON Object
    • Added ORDER_LINE_ITEM_STATUS_UPDATED to event enumeration and added OrderLineItemStatusChanged as possible payload

New JSON Objects

  • OrderLineItemStatusChanged JSON Object
  • OrderLineItemChange JSON Object

V2 - 2/21/2018

This change is completely backward compatible and simply adds functionality to existing APIs.

Modified APIs

  • findOrders
    • until search attribute added
  • findOrderShipments
    • until search attribute added
  • findOrderStatuses
    • until search attribute added
  • findItemInventory
    • until search attribute added
    • dscoSuppilerId attribute added
    • dscoSupplierTradingPartnerId added
  • findInvoices
    • until search attribute added

V2 - 1/17/2018

This change is completely backward compatible and simply adds functionality to existing APIs.

New Functionality

  • Anywhere a retailer could have specified a unique identifier for an item, such as an order line item, the retailer may now provide partnerSku as the unique identifier assuming the partnerSku value has been created for the given item by the supplier for the retailer to use.

New Objects

  • OrderBillTo JSON Object
  • OrderCoupon JSON Object
  • OrderPayment JSON Object
  • PackageShipFrom JSON Object
  • PackageShipTo JSON Object
  • PartnerSkuMap JSON Object
  • OrderLineItemActivity JSON Object
  • OrderTax JSON Object

Modified Objects

  • ItemInventory JSON Object
    • partnerSku Added
    • partnerSkuMap Added
  • Invoice JSON Object
    • dscoRetailerName Added
    • dscoSupplierName Added
  • InvoiceLineItem JSON Object
    • Added these attributes: partnerSku, upc, ean, originalLineNumber, originalOrderQuantity, dscoPackageId, shipWeight, shipWeightUnits
    • sku is no longer required if partnerSku or upc or ean or dscoItemId is provided
  • InvoiceShipFromTo JSON Object
    • Added these attributes
      attention, email, phone, storeNumber
  • InvoiceShipInfo JSON Object
    • dscoPackageId Added
  • ItemKey JSON Object
    • PARTNER_SKU type added to itemKeyType attribute
  • Order JSON Object
    • Added these attributes: shipCarrier, shipMethod, dscoShipCarrier, dscoShipMethod, dscoShippingServiceLevelCode, retailerShipCarrier, retailerShipMethod, retailerShippingServiceLevelCode, giftFlag, giftMessage, giftToName, giftFromName, receiptId, giftReceiptId,  taxes, shippingSurcharge, numberOfLineItems, coupons, payments, billTo
    • shippingServiceLevelCode should no longer be used by retailers when creating an order, instead retailerShippingServiceLevelCode should be set (Dsco will translate for a period of time to ensure backward compatibility)
  • OrderLineItem JSON Object
    • Added these attributes: partnerSku, receiptId, giftFlag, giftReceiptId, giftToName, giftFromName, giftMessage, color, size, retailPrice, surchargePrice, taxes, activity
  • OrderStatusLineItem JSON Object
    • partnerSku added
  • Package JSON Object
    • Added these attributes: dscoActualShipMethod, dscoActualShipCarrier, dscoActualShippingServiceLevelCode, dscoActualShipCost, dscoActualDeliveryDate, dscoActualPickupDate, returnedFlag, returnDate, returnNumber, returnReason, numberOfLineItems, shipFrom, shipTo, dscoPackageId, shipWeight, shipWeightUnits
  • PackageLineItem JSON Object
    • Added these attributes: partnerSku, upc, ean, lineNumber, originalLineNumber, originalOrderQuantity
  • Shipment JSON Object
    • Added these attributes: dscoRetailerName, dscoSupplierName, dscoTradingPartnerId, dscoTradingPartnerName, retailerShipCarrier, retailerShipMethod, retailerShippingServiceLevelCode, dscoShipCarrier, dscoShipMethod, dscoShippingServiceLevelCode, retailerExpectedDeliveryDate, retailerRequiredDeliveryDate, consumerOrderNumber
  • Shipping JSON Object
    • storeNumber Added
    • carrier - deprecated and will be removed in the future, instead retailers should use Order.retailerShipCarrier when creating an order and suppliers should use Order.shipCarrier when receiving an order
    • method - deprecated and will be removed in the future, instead retailers should use Order.retailerShipMethod when creating an order and suppliers should use Order.shipMethod when receiving an order

Modified APIs

  • FindItemInventory
    • partnerSku Added
    • dscoRetailerId Added
    • dscoTradingPartnerId Added
  • FindOrderShipments
    • returnedOnly Added

V2 - 11/9/2017

This change is completely backward compatible and simply adds functionality to existing APIs.

Modified APIs

  • Webhook INVENTORY_UPDATED quantityStateChangeOnly
  • Modified INVENTORY_UPDATED quantityStateChangeOnly events to also fire when an item is updated to 0 quantity when it was already set to 0 quantity.

Modified Objects

  • Invoice JSON Object
    • dscoTradingPartnerId added
    • dscoTradingPartnerName added

V2 - 10/28/2017

This change is completely backward compatible and simply adds functionality to existing APIs.

Modified APIs

  • GetAllItemInventory
    • Increased performance and added a new compress attribute, returning each page of results compressed (provides dramatic performance improvement)
    • Changed search semantics for updatedSince attribute (see date search semantics section of GetAllItemInventory API)
  • CreateOrder
    • dscoSupplierId is no longer required at root of Order object
    • dscoTradingPartnerId may be provided in lieu of dscoSupplierId to identify supplier to use
    • Added upc and ean to the list of unique item identifiers that may be used on a line item to identify the item in the Dsco system (dscoItemId and sku were present before)
    • The supplier to use to fulfill a lineItem may be explicitly specified using dscoTradingPartnerId in lieu of supplierId which could be used before this change
    • Added more descriptive error messages for failures
  • Add Webhook
    • Added two new webhook event types to notify when invoices are created or updated: INVOICE_CREATED, INVOICE_UPDATED
      Review the Webhook Overview doc for more details.
  • FindItemInventory
    • The semantics of searching by dates has changed  (see date search semantics section of FindItemInventory)

Modified Objects

  • Order JSON Object
    • Added expectedDeliveryDate
    • Added marketingMessage
    • Added message
    • Added packingInstructions
    • Added requiredDeliveryDate
    • Added shipToStoreNumber
    • Added packingInstructions
    • Added shipInstructions
  • OrderLineItem JSON Object
    • Added dscoTradingPartnerId
    • Added upc
    • Added ean
    • Added lineNumber
    • Added message
    • Added packingInstructions
    • Added shipInstructions
  • AllItemInventoryResult JSON Object
    • Made the itemInventory attribute optional
    • Added optional base64EncodedCompressedItemInventory attribute
  • Webhook JSON Object
    • Added INVOICE_CREATED as a valid event type
    • Added INVOICE_UPDATED as a valid event type

V2 - 09/23/2017

This change is completely backward compatible and simply modifies a single JSON object.

Added these attributes to the Order JSON object:

  • dscoAcknowledgeLateDate
  • dscoCancelLateDate
  • dscoShipLateDate
  • dscoInvoiceLateDate

V2 - 08/24/2017

This change is completely backward compatible and simply modifies an existing API call.

Modified API

  • Update Item Inventory
    • This API has been modified to update if the item inventory can be found and to create the item inventory if it cannot be.  The name of the API has been modified to be Create or Update Item Inventory although the signature of the API itself hasn't change: POST /v2/iteminventory.

V2 - 08/10/2017

This change is completely backward compatible and simply adds additional attributes and objects.

New APIs

  • Added Assortment Management APIs
    • List all Assortments
      • Lists the assortments created
    • Create an Assortment
      • Create a new assortment
    • Delete Assortment
      • Delete an assortment
    • Find Assortment
      • Find an assortment by its ID
    • Update Assortment
      • Update an existing assortment
    • Remove Item From Assortment
      • Remove an item from an existing assortment
    • Remove Items From Assortment
      • Remove a list of items from an existing assortment
    • Add Item To Assortment
      • Add an item to an existing assortment
    • Add Items To Assortment
      • Adds a list of items to an existing assortment

New Objects

  • DscoItemIdOrItemKey
    • Unique ID for an item
  • DscoItemIdsOrItemKeys
    • A list of unique IDs for a set of items
  • Assortment
    • An assortment object
  • ItemKey
    • Specifies the key to identify an item

V2 - 06/01/2017

This change is completely backward compatible and simply adds additional attributes and objects.

Modified API

  • Create Webhook
    • Added a new attribute customHttpHeaders
  • Update Webhook
    • Added a new attribute customHttpHeaders
  • List Webhooks
    • Added a new attribute customHttpHeaders
  • Get Webhook By ID
    • Added a new attribute customHttpHeaders

New Object

  • HttpHeader
    • Represents an http header to be sent with a webhook callback.

V2 - 05/07/2017

This change is completely backward compatible and simply adds additional attributes and objects.

Modified API

  • Find Item Inventory
    • New attributes "fastMode" and "lastId" have been added that enable faster responses with large data sets.

Modified Object

  • PagedItemInventory
    • A new attribute "lastId" has been added to enable paging through results in a more performant manner.

V2 - 02/15/2017

This change is completely backward compatible and simply adds additional attributes and objects.

New API

  • Get All Item Inventory

New Object

  • AllItemInventoryResult

Modified Object

  • Webhook
    • Added quantityChangeOnly attribute to allow the creation of an InventoryUpdate webhook that only triggers when quantity changes

V2 - 02/01/2017

This change is completely backward compatible and simply adds additional attributes and objects.

Modified APIs

  • Update Order Status: added lineItems attribute allowing for updating line item status and quantity statuses

New JSON Objects

  • OrderStatusLineItem

Modified JSON Objects

  • ItemInventory (new attributes added)
    • brand
  • OrderLineItem (new attributes added)
    • status
    • statusReason
    • cancelledQuantity
    • cancelledReason
    • acceptedQuantity
    • acceptedReason
    • rejectedQuantity
    • rejectedReason
  • OrderStatus (new attributes added)
    • items

V2 - 11/27/2016

This change is completely backward compatible and simply adds additional fields to the ItemInventory JSON object.

Modified JSON Objects

  • ItemInventory
    • Added tradingPartnerId and tradingPartnerName

V2 - 11/15/2016

This change is completely backward compatible and simply adds additional fields to the Order JSON object.

Modified JSON Objects

  • Order
    • Added shipByDate, acknowledgeByDate, and invoiceByDate

V2 - 11/03/2016

This change is completely backward compatible and simply adds additional fields and functionality.

This change adds new invoice APIs and adds additional attributes to ItemInventory.

New APIs

  • Create Invoice API
  • Find Invoices API
  • Update Invoice API

Modified APIs

  • Find Item Inventory: added ability to search by upc, ean, mpn, isbn, and gtin

New JSON Objects

  • Invoice
  • InvoiceLineItem
  • InvoiceShipFromTo
  • InvoiceShipInfo
  • InvoiceTerms
  • InvoiceCharge
  • ItemWarehouse
  • PagedInvoiceResult

Modified JSONObjects

  • ItemInventory
    • Added upc, ean, mpn, isbn, gtin, and warehouses attributes

V2 - 09/14/2016

This change is completely backward compatible and simply adds additional fields and functionality.

Modified JSON Objects

  • Webhook JSON Object
    • Added the applyToPartners attribute allowing a webhook to be created by a retailer for inventory updates and applied to all suppliers.
    • Added the quantityStateChangeOnly attribute allowing a webhook created for inventory updates to only fire when the quantity changes from less than 1 to more than zero and vice versa

 Modified APIs

  • Modified the webhook API calls to a partner's endpoint to include the Content-MD5 hash of the payload of the API so partner's can verify the identity and correctness of the request

V2 - 08/13/2016

Dsco is adding additional server capacity to the Dsco public API infrastructure effective 8/13/2016. This is purely an infrastructure release. No APIs have changed.

This change should not affect api.dropship.com nor its IP address. However, we are making api.dropship.com point to a load balancer. You will want to work with your IT team to ensure any firewall rules continue to work after the switchover for any incoming Webhook API calls from that server as the incoming IP address may appear to be different to your firewall.

IP address of api.dropship.com: 52.72.74.224

Further, we are deprecating the api.dropship.com endpoint in favor of our new endpoint which is: api.dsco.io

The IP address of the api.dsco.io endpoint is: 52.1.219.81

We will continue to support the api.dropship.com endpoint until the end of Q1 2017 (March 31, 2017) after which it will be shut down, so please plan accordingly.

V2 - 04/02/2016

Modified JSON Objects

  • Order JSON Object
    • Added a new attribute to identify the status of an order as shipment pending.

V2 - 09/15/2015

Modified APIs

  • POST /v2/order
    • The create order API now returns an array of orders instead of a single order to allow an order to be fulfilled by multiple suppliers.

Modified JSON Objects

  • Order JSON Object
    • testFlag - new attribute that marks the order as a test order that will only be used for testing purposes
    • currencyCode - new attribute to specify the currency of the order
    • cancelAfterDate - new attribute specifying that the order should be canceled after this date
    • consumerOrderNumber - new attribute providing a consumer order number
    • shippingServiceLevelCode - new attribute specifying the shipping service of the order
  • OrderLineItem JSON Object
    • warehouseCode - new attribute to specify the warehouse of the line item
  • Shipment JSON Object
    • currencyCode - new attribute to specify the currency of the order
    • shipCarrier - new attribute specifying ship carrier
    • shipMethod - new attribute specifying ship method
    • shippingServiceLevelCode - new attribute specifying shipping service level
  • Package JSON Object
    • currencyCode - new attribute to specify the currency of the order
    • shippingServiceLevelCode - new attribute specifying shipping service level

V1 - 01/15/2015

The initial release of the APIs.

Was this article helpful?
0 out of 1 found this helpful

Comments

0 comments

Please sign in to leave a comment.