Order

Modified: 6/28/2024

A minimal order requires only the fields in bold.

Fields

Field Name Data Type Description
retailerCode String 5 This is the code that Mercury Commerce has for each retailer, you must contact them to receive the code prior to sending any orders.
orderCorrelationId GUID A read only unique identifier that can be used to track an order through the VendorBridge service.
purchaseOrderNumber String 50 Purchase Order number from the retail partner.
OrderNumbers Array of OrderNumber Additional numbers related to this Purchase Order.
test Boolean If true the order will be marked as test, the default value is false..
departmentCode String 100 Retailers ordering department code.
created DateTime When the order was created. If not specified the purchase order date will be used.
purchaseOrderDate Date Time specified by retail partner.
requestedShipDate Date Ship by date.
requestedDeliveryDate Date Deliver by date.
cancelAfterDate Date Cancel if not shipped by date.
invoiceDate Date Date that VendorBridge created the invoice. This may not be the same time that a retailer has due to transmission time or when they process the invoice.
addresses Array of Address All addresses associated to the order. Only the Ship To address is required.
details Array of Detail At least one detail is required.
orderNotes Array of String Messages that appear when viewing an order.
shippingInstruction String 255 Shipping instructions.
personalMessage String Personal/Gift message.
rushOrder Boolean Works in conjuction with VendorBridge rush order handling.
giftWrap Boolean Works in conjuction with VendorBridge gift wrap function.
carrierSCAC SCAC Must be one of the valid SCAC codes.
shippingAccount Third Party Shipping Account Number
freightDescription String 50 Description of the carrier service.
totals Array of Total The totals that the consumer sees or the total that the vendor charges.
customerOrderNumber String 50 Purchase order number specified by the customer.
thirdPartyOrderNumber String 30 Purchase Order number from a third party entity.
thirdPartyAssociatedNumber String 30 Order number in your system.
thirdPartyAdditionalNumber String 30 Because you can never have enough numbers.
internalVendorNumber String 22 Because you can never have enough numbers.

Updates

6/28/2024
Added Third Party Shipping Account Number
7/26/2023
Added invoice date
7/28/2022
Added order numbers array
Depricated customerOrderNumber
Depricated thirdPartyOrderNumber
Depricated thirdPartyAssociatedNumber
Depricated thirdPartyAdditionalNumber
Depricated internalVendorNumber
Moved depricated fields to bottom of page