Outbound Integration

Managing External Publication

To setup external data publication to a third party system, you must perform two actions. The first is to define the endpoint in the External Service Administration screen in EICS Technical Maintenance. If this is not configured, no messages will be written into the MPS queues to publish. The second is to activate the appropriate DPS (Data Publish Service) work thread in MPS Work Types. The table below contains the DPS work queue matched with its external publish endpoint.

MPS Work Type	MPS Message Type	External Service Administration
DpsCountSchedule	DpsCountSchedule	StockCountSchduleExternalService
DpsCustomerOrder	DpsCustOrderConfirm	FulfillmenOrderExternalService
DpsCustomerOrder	DpsCustOrderReject	FulfillmenOrderExternalService
DpsCustomerOrder	DpsCustOrderStatus	FulfillmenOrderExternalService
DpsDsdReceipt	DpsDsdReceipt	VendorDeliveryReceiptExternalService
DpsFiscalDocument	DpsFisalDocRequest	FiscalDocumentExternalService
DpsFiscalDcoument	DpsFisalDocCancel	FiscalDocumentExternalService
DpsInvAdjustment	DpsCoInvAvailable	CoAvailableInventoryExternalService
DpsInvAdjustment	DpsInvAdjustment	InventoryAdjustmentExternalService
DpsNotification	DpsNotification	NotificationExternalService
DpsShipment	DpsPreShipment	PreShipmentExternalService
DpsShipment	DpsShipment	ShipmentExternalService
DpsStockStatus	DpsTransferStatus	TransferStatusExternalService
DpsStoreOrder	DpsStoreOrder	StoreOrderExternalService
DpsTicketPrint	DpsTicketPrint	TicketPrintExternalService
DpsTransferReceipt	DpsTransferReceipt	TransferDeliveryReceiptExternalService
DpsVendorReturn	DpsRtvStatus	VendorReturnExternalService

Integration with Customer Order System

REST Service: Fulfillment Order Address (External)

When shipping to customer during the fulfillment order workflow, EICS retrieves the address for the order delivery from an external order managements system. When viewing delivery address information within the client application, it also retrieves it from an external system.

This service must be implemented by an external system that will provide the customer address for a particular customer order. SIOCS does not store customer information and retrieves it from this external endpoint just prior to shipping.

Order Address

This section describes the Order Address API. This API retrieve the address of the customer for a particular order.

Method

POST

URL

/orderaddress

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the order and customer in order to retrieve the proper address.

Example Value

{
  "customerOrderNo": "111222333",
  "fulfillmentOrderNo": "444555666",
  "storeId": 5000
}

Schema — FulfillmentOrderAddressCriticalExtIdo

Table 6-1 FulfillmentOrderAddressCriticalExtIdo— Object

Element Name	Required	Data Type/Example	Description
customerOrderNo	NA	string($text128) example: 111222333	The customer order number.
fulfillmentOrderNo	NA	string($text128) example: 444555666	The fulfillment order number.
storeId	NA	number($int10) example: 5000	The identifier of the store that will fulfill the order.

Responses

This section describes the responses of the Order Address API.

Response Code: 200

The request has been successful.

The media type is application/json.

Example Value

[
  {
    "billingAddress1": "Box 110",
    "billingAddress2": "Apartment Block 2534",
    "billingAddress3": "4th Avenue North",
    "billingCity": "Blaketon",
    "billingState": "MN",
    "billingCountryCode": "USA",
    "billingCounty": "Bernard",
    "billingCompanyName": "Holdings Consolidated",
    "billingEmailAddress": "janice.smith@email.com",
    "billingFirstName": "Janice",
    "billingLastName": "Smith",
    "billingPhoneNumber": "555-765-2452",
    "billingPhoneticFirst": "jan-iss",
    "billingPhoneticLast": "Smith",
    "billingPostalCode": "55555",
    "customerNumber": "A123B44",
    "deliveryAddress1": "Box 110",
    "deliveryAddress2": "Apartment Block 2534",
    "deliveryAddress3": "4th Avenue North",
    "deliveryCity": "Blaketon",
    "deliveryState": "MN",
    "deliveryCountryCode": "USA",
    "deliveryCounty": "Bernard",
    "deliveryPostalCode": "55555",
    "deliveryCompanyName": "Holdings Consolidated",
    "deliveryEmailAddress": "janice.smith@email.com",
    "deliveryFirstName": "Janice",
    "deliveryLastName": "Smith",
    "deliveryPhoneNumber": "555-765-2452",
    "deliveryPhoneticFirst": "jan-iss",
    "deliveryPhoneticLast": "smith",
    "deliveryPreferredName": "Jan"
  }
]

Schema — FulfillmentOrderAddressExtIdo

Table 6-2 FulfillmentOrderAddressExtIdo— Object

Element Name	Required	Data Type/Example	Description
billingAddress1	NA	string($text240) example: Box 110	The first billing address line.
billingAddress2	NA	string($text240) example: Apartment Block 2534	The second billing address line.
billingAddress3	NA	string($text240) example: 4th Avenue North	The third billing address line.
billingCity	NA	string($text120) example: Blaketon	The billing address city name.
billingState	NA	string($text3) example: MN	The billing address state code.
billingCountryCode	NA	string($text3) example: USA	The billing address country code.
billingCounty	NA	string($text250) example: Bernard	The billing address county name.
billingCompanyName	NA	string($text120) example: Holdings Consolidated	The billing address company name.
billingEmailAddress	NA	string($text100) example: janice.smith@email.com	The billing contact email address.
billingFirstName	NA	string($text120) example: Janice	The billing contact first name.
billingLastName	NA	string($text120) example: Smith	The billing contact last name.
billingPhoneNumber	NA	string($text20) example: 555-765-2452	The billing contact phone number.
billingPhoneticFirst	NA	string($text120) example: jan-iss	The billing contact phonetic spelling of first name.
billingPhoneticLast	NA	string($text120) example: Smith	The billing contact phonetic spell of last name.
billingPostalCode	NA	string($text30) example: 55555	The billing address postal code.
customerNumber	NA	string($text14) example: A123B44	The customer number of the customer who placed the order.
deliveryAddress1	NA	string($text240) example: Box 110	The first delivery address line.
deliveryAddress2	NA	string($text240) example: Apartment Block 2534	The second delivery address line.
deliveryAddress3	NA	string($text240) example: 4th Avenue North	The third delivery address line.
deliveryCity	NA	string($text120) example: Blaketon	The delivery address city name.
deliveryState	NA	string($text3) example: MN	The delivery address state code.
deliveryCountryCode	NA	string($text3) example: USA	The delivery address country code.
deliveryCounty	NA	string($text250) example: Bernard	The delivery address county name.
deliveryPostalCode	NA	string($text30) example: 55555	The delivery address postal code.
deliveryCompanyName	NA	string($text120) example: Holdings Consolidated	The company name at the delivery address.
deliveryEmailAddress	NA	string($text100) example: janice.smith@email.com	The email address of the delivery contact.
deliveryFirstName	NA	string($text120) example: Janice	The first name of the delivery contact.
deliveryLastName	NA	string($text120) example: Smith	The last name of the delivery contact.
deliveryPhoneNumber	NA	string($text20) example: 555-765-2452	The phone number of the delivery contact.
deliveryPhoneticFirst	NA	string($text120) example: jan-iss	The phonetic spelling of the first name of the delivery contact.
deliveryPhoneticLast	NA	string($text120) example: smith	The phonetic spelling of the last name of the delivery contact.
deliveryPreferredName	NA	string($text120) example: Jan	The preferred name of the delivery contact.

REST Service: Customer Fulfillment Order Status (External)

This service must be implemented by an external system that wants to receive notices from EICS about that state of customer fulfillment orders.

Order Query

This operations queries an order. It retrieves real-time order from the order management system to verify prior to shipping.

Method

POST

URL

/orderstatus/query

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the fulfillment order to be queried.

Example Value

{
  "customerOrderId": "222345666",
  "fulfillmentOrderId": "76544400",
  "storeId": 1234
}

Schema — FulfillmentOrderCriteriaIdo

Table 6-3 FulfillmentOrderCriteriaIdo— Object

Element Name	Required	Data Type/Example	Description
customerOrderId	Yes	string($text128) example: 222345666	The customer order number (from the external ordering system).
fulfillmentOrderId	NA	string($text128) example: 76544400	The fulfillment order number (from the external ordering system).
storeId	Yes	number($int10) example: 1234	The identifier of the store at which this order will be fulfilled.

Responses

This section describes the responses of the Order Query API.

Response Code: 200

The request has been successful.

The media type is application/json.

Example Value

[
  {
    "customerOrderId": "222345666",
    "lineItems": [
      {
        "itemId": "55001234",
        "completedQuantity": 2,
        "canceledQuantity": 10
      }
    ]
  }
]

Schema — FulfillmentOrderExtIdo

Table 6-4 FulfillmentOrderExtIdo— Object

Element Name	Required	Data Type/Example	Description
customerOrderId	Yes	string($text128) example: 222345666	The customer order number (from the external ordering system).
lineItems	NA	object	A collection of line items on the fulfillment order.

Table 6-5 FulfillmentOrderItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
itemId	Yes	string($text25) example: 55001234	The SKU level item identifier.
completedQuantity	NA	number($int10) example: 2	The amount of the item ordered that has been completed.
canceledQuantity	NA	number($decimal(12,4)) example: 10	The amount of the item ordered that has been canceled.

Order Accepted

This operation will be accessed when a new fulfillment order has been created at the store, sending the information about the ordered quantities confirmed on that order.

Method

POST

URL

/orderstatus/accept

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the fulfillment order that was accepted.

Example Value

{
  "customerOrderId": "222345666",
  "fulfillmentOrderId": "76544400",
  "storeId": 1234,
  "lineItems": [
    {
      "itemId": "55001234",
      "lineNumber": 2,
      "quantityOrdered": 10
    }
  ]
}

Schema — FulfillmentOrderAcceptExtIdo

Table 6-6 FulfillmentOrderAcceptExtIdo— Object

Element Name	Required	Data Type/Example	Description
customerOrderId	Yes	string($text128) example: 222345666	The customer order number (from the external ordering system).
fulfillmentOrderId	NA	string($text128) example: 76544400	The fulfillment order number (from the external ordering system).
storeId	Yes	number($int10) example: 1234	The identifier of the store at which this order will be fulfilled.
lineItems	Yes	object	A collection of accepted line items on the fulfillment order.

Table 6-7 FulfillmentOrderAcceptItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
itemId	Yes	string($text25) example: 55001234	The SKU level item identifier.
lineNumber	NA	number($int10) example: 2	The line number of the fulfillment order this item is fulfilling.
quantityOrdered	Yes	number($decimal(12,4)) example: 10	The quantity accepted on this line item.

Responses

This section describes the responses of the Order Accept API.

Response Code: 204

No content

Order Rejected

This service will be accesses when a new fulfillment order has been rejected by the store.

Method

POST

URL

/orderstatus/reject

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the fulfillment order that was rejected.

Example Value

{
  "customerOrderId": "222345666",
  "fulfillmentOrderId": "76544400",
  "storeId": 1234
}

Schema — FulfillmentOrderRejectIdo

Table 6-8 FulfillmentOrderRejectIdo— Object

Element Name	Required	Data Type/Example	Description
customerOrderId	Yes	string($text128) example: 222345666	The customer order number (from the external ordering system).
fulfillmentOrderId	NA	string($text128) example: 76544400	The fulfillment order number (from the external ordering system).
storeId	Yes	number($int10) example: 1234	The identifier of the store at which this order will be fulfilled.

Responses

This section describes the responses of the Order Rejected API.

Response Code: 204

No content

Order Status

This service will be accessed when the state of an order changes sending complete details about the fulfillment order. This occurs when order quantity reservations change, when picking occurs, when reverse picking occurs, and when a delivery is shipped.

Method

POST

URL

/orderstatus/status

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the fulfillment order.

Example Value

{
  "orderId": 11111,
  "customerOrderId": "222345666",
  "fulfillmentOrderId": "76544400",
  "storeId": 1234,
  "customerId": "JXA244443",
  "orderType": 1,
  "deliveryType": 1,
  "status": 1,
  "orderDate": "2025-02-07T10:34:03.411Z",
  "releaseDate": "2025-02-07T10:34:03.411Z",
  "deliveryDate": "2025-02-07T10:34:03.411Z",
  "carrierId": 4500674,
  "carrierServiceId": 573314534,
  "allowPartialDelivery": true,
  "deliveryCharge": 4500674,
  "deliveryChargeCurrency": "USD",
  "holdLocation": "Pickup Desk",
  "orderComments": "Customer will arrive by 2pm.",
  "underReview": false,
  "quickFlow": true,
  "deliveryComments1": "First line.",
  "deliveryComments2": "Second line.",
  "deliveryComments3": "Third line.",
  "customerArrivalDate": "2025-02-07T10:34:03.411Z",
  "createDate": "2025-02-07T10:34:03.411Z",
  "updateDate": "2025-02-07T10:34:03.411Z",
  "activityType": 1,
  "systemCode": "INV",
  "lineItems": [
    {
      "lineId": 333444,
      "itemId": "55001234",
      "substituteLineId": 5600043,
      "lineNumber": 2,
      "preferredUom": "KG",
      "comments": "Item packaging slightly damaged.",
      "quantityOrdered": 10,
      "quantityPicked": 6,
      "quantityDelivered": 2,
      "quantityCanceled": 2,
      "quantityReserved": 8,
      "allowSubstitution": true,
      "price": 4500674,
      "priceCurrency": "USD",
      "createDate": "2025-02-07T10:34:03.411Z",
      "updateDate": "2025-02-07T10:34:03.411Z"
    }
  ]
}

Schema — FulfillmentOrderStatusExtIdo

Table 6-9 FulfillmentOrderStatusExtIdo— Object

Element Name	Required	Data Type/Example	Description
orderId	NA	number($int12) example: 11111	The unique identifier of the fulfillment order.
customerOrderId	NA	string($text128) example: 222345666	The customer order number (from the external ordering system).
fulfillmentOrderId	NA	string($text128) example: 76544400	The fulfillment order number (from the external ordering system).
storeId	NA	number($int10) example: 1234	The identifier of the store at which this order will be fulfilled.
customerId	NA	string($text14) example: JXA244443	The identifier of the customer for this fulfillment order.
orderType	NA	integer($int4) example: 1	The order type of the customer order. Valid values are: 1 - Layaway 2 - Pickup and Delivery 3 - Customer Order 4 - Pending Purchase 5 - Special Order 6 - Web Order 7 - On Hold Enum: [ 1, 2, 3, 4, 5, 6, 7 ]
deliveryType	NA	integer($int4) example: 1	The delivery type of the customer order. Valid values are: 1 - Customer Pickup 2 - Ship To Store 3 - Layaway 4 - On Hold 5 - POS Order Enum: [ 1, 2, 3, 4, 5 ]
status	NA	integer($int4) example: 1	The current status of the customer order. Value values are: 1 - New 2 - In Progress 3 - Completed 4 - Canceled 5 - Reverse Pick 6 - Pick In Progress 7 - Delivery In Progress 8 - Ready To Ship 9 - Ready For Pickup 10 - Picking Required 11 - Under Review Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 ]
orderDate	NA	string($date-time)	The date the customer placed the order.
releaseDate	NA	string($date-time)	The date in which the order must be shipped by the store or picked up in the store.
deliveryDate	NA	string($date-time)	The date in which the order is to be delivered.
carrierId	NA	integer($int10) example: 4500674	The identifier of the carrier who will deliver the order.
carrierServiceId	NA	integer($int10) example: 573314534	The identifier of the carrier service used for the delivery.
allowPartialDelivery	NA	boolean example: true	True indicates delivery can occur without all items being available and ready. False indicates all items must be shipped in the delivery.
deliveryCharge	NA	number($decimal(12,4)) example: 4500674	The cost of shipment of this order.
deliveryChargeCurrency	NA	string($text3) example: USD	The currency of the delivery charge value.
holdLocation	NA	string($text128) example: Pickup Desk	Descripton of where the order is being held for pickup or delivery.
orderComments	NA	string($text2000) example: Customer will arrive by 2pm.	Comments entered in the external system for the order.
underReview	NA	boolean example: false	True indicates that the fulfilling system needs to delay either shipping or fulfilling the order until this flag is cleared.
quickFlow	NA	boolean example: true	True indicates the customer order is fulfilled using the quick flow JET mobile process. False indicates the standard process was used.
deliveryComments1	NA	string($text128) example: First line.	The first line of delivery comments.
deliveryComments2	NA	string($text128) example: Second line.	The second line of delivery comments.
deliveryComments3	NA	string($text128) example: Third line.	The third line of delivery comments.
customerArrivalDate	NA	string($date-time)q	The date that the customer arrived for pickup.
createDate	NA	string($date-time)	The date the fulfillment order was created in SIOCS.
updateDate	NA	string($date-time)	The date the fulfillment order was last updated in SIOCS.
activityType	NA	integer($int4) example: 1	1 - Delivery Dispatch 2 - Order Pick 3 - Order Reservation 4 - Order Reverse Pick Enum: [ 1, 2, 3, 4 ]
systemCode	NA	string($text10) example: INV	A system code indicating the system of origin of this content.
lineItems	NA	object	A collection of line items on the fulfillment order.

Table 6-10 FulfillmentOrderStatusItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
lineId	NA	number($int12) example: 333444	The unique identifier of the line item.
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
substituteLineId	NA	number($int12) example: 5600043	The identifier of a line item that this item has been substituted for.
lineNumber	NA	number($int10) example: 2	The line number of the fulfillment order this item is fulfilling.
preferredUom	NA	string($text4) example: KG	The preferred unit of measure the item quantities should be processed or displayed in.
comments	NA	string($text2000) example: Item packaging slightly damaged.	Comments from an external system associated to this item.
quantityOrdered	NA	number($decimal(12,4)) example: 10	The quantity ordered on this line item.
quantityPicked	NA	number($decimal(12,4)) example: 6	The quantity picked for this line item.
quantityDelivered	NA	number($decimal(12,4)) example: 2	The quantity delivered to date on this line item.
quantityCanceled	NA	number($decimal(12,4)) example: 2	The quantity canceled on this line item.
quantityReserved	NA	number($decimal(12,4)) example: 8	The quantity reserved for this line item.
allowSubstitution	NA	boolean example: true	True indicates a substitution is allowed for this item, false indicates it is not.
price	NA	number($decimal(20,4)) example: 4500674	The amount of the price of the item.
priceCurrency	NA	string($text3) example: USD	The currency of the price of the item.
createDate	NA	string($date-time)	The date the order item was created in SIOCS.
updateDate	NA	string($date-time)	The date the order item was last updated in SIOCS.

Responses

This section describes the responses of the Order Status API.

Response Code: 204

No content

Integration of Direct From Vendor Receipts

EICS publishes out a vendor delivery receipt (DCS receipt) to an external endpoint when the delivery is confirmed. The service must be configured on the external services administration screen.

REST Service: Vendor Delivery Receipt (External)

This service publishes out the information about a vendor delivery receipt (DSD Receipt) to an external endpoint. This occurs when the vendor delivery receipt is confirmed.

Receipt Confirmed

A receipt information is sent via this operation when a vendor delivery receipt is confirmed.

Method

POST

URL

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the vendor delivery receipt that was confirmed.

Example Value

{
  "supplierId": 5510,
  "storeId": 5000,
  "receiptNumber": "A3DA",
  "invoiceNumber": "1004728342",
  "invoiceDate": "2026-02-24T13:44:20.044Z",
  "receiptDate": "2026-02-24T13:44:20.044Z",
  "deliveryType": 1,
  "originatingCountryCode": "CAN",
  "currencyCode": "CAD",
  "carrierCode": "SHP",
  "containers": [
    {
      "cartonId": 55001234,
      "externalCartonId": "234342",
      "trackingNumber": "863413410",
      "receiptDate": "2026-02-24T13:44:20.044Z",
      "adjusted": false,
      "missing": false,
      "items": [
        {
          "itemId": "55001234",
          "vendorProductNumber": "55001234",
          "quantityExpected": 10,
          "quantityReceived": 10,
          "quantityDamaged": 5,
          "caseSize": 100,
          "purchaseOrderId": 7444567333,
          "externalPurchaseOrderId": "55001234",
          "customerOrderNumber": "143523465425",
          "fulfillmentOrderNumber": "134314",
          "unitCostValue": 11.5,
          "uins": [
            {
              "uin": "20343932434",
              "status": 1
            }
          ],
          "extendedAttributes": [
            {
              "generatedBarcode": "(01)12345678901234(15)20251105",
              "quantity": 22,
              "values": [
                {
                  "code": "15",
                  "externalCode": "15",
                  "valueDate": "2026-02-24T13:44:20.044Z",
                  "valueLong": 678334324,
                  "valueDecimal": 1488.99,
                  "valueText": "12365478943255"
                }
              ]
            }
          ]
        }
      ]
    }
  ]

Schema — VendorDeliveryReceiptExtIdo

Table 6-11 VendorDeliveryReceiptExtIdo — Object

Element Name	Required	Data Type/Example	Description
supplierId	NA	number($int10) example: 5510	The identifier of the supplier that shipped the goods.
storeId	NA	number($int10) example: 5000	The identifier of the store receiving the goods.
receiptNumber	NA	number($int12) example: A3DA	The receipt number of the delivery.
invoiceNumber	NA	string($text128) example: 1004728342	The invoice number of the delivery.
invoiceDate	NA	string($date-time)	The date of the invoice.
receiptDate	NA	string($date-time)	The date the delivery was received.
deliveryType	NA	number($int2) example: 1	The type of delivery. Valid values are: 1 - ASN 2 - PO 3 - DEX-NEX 4 - Manual Enum: [ 1, 2, 3, 4 ]
originatingCountryCode	NA	string($text3) example: CAN	The country code of the country of origin.
currencyCode	NA	string($text3) example: CAD	The currency code of the delivery.
carrierCode	NA	string($text4) example: SHP	The carrier code of the delivery carrier.
containers	NA	object	A collection of containers on the delivery.

Table 6-12 VendorDeliveryReceiptContainerExtIdo — Object

Element Name	Required	Data Type/Example	Description
cartonId	NA	number($int12) example: 55001234	The internal system container identifier.
externalCartonId	NA	string($text128) example: 234342	An external system carton identifier for reference.
trackingNumber	NA	string($text124) example: 863413410	The tracking number of the container.
receiptDate	NA	string($date-time)	The date the container was received.
adjusted	NA	boolean example: false	True if the carton is adjusted from a previous receipt, false if it is the first receipt of this container.
missing	NA	boolean example: false	True if the carton is missing from the receipt, false if it is received.
items	NA	object	A collection of line items within the container.

Table 6-13 VendorDeliveryReceiptItemExtIdo — Object

Element Name	Required	Data Type/Example	Description
itemId		string($text25) example: 55001234	The SKU level item identifier.
vendorProductNumber		string($text256) example: 55001234	The vendor product number of the item/sku.
quantityExpected		number($decimal(20,4)) example: 10	The quantity originally expected to be received.
quantityReceived		number($decimal(20,4)) example: 10	The quantity received (as not damaged) for the item in this container.
quantityDamaged		number($decimal(20,4)) example: 5	The quantity received as damage for the item in this container.
caseSize		number($decimal(10,4)) example: 100	The case size of the item on this receipt.
purchaseOrderId		number($int12) example: 7444567333	The purchase order identifier if associated to a purchase order.
externalPurchaseOrderId		string($text128) example: 55001234	The external purchase order number if the purchase order originated from an external system.
customerOrderNumber		string($text128) example: 143523465425	The customer order number if associated to a customer order.
fulfillmentOrderNumber		string($text128) example: 134314	The fulfillment order number if associated to a customer order.
unitCostValue		number($decimal(12,4)) example: 11.5	The unit cost amount for this item on the receipt.
uins		object	A collection of uins on the item.
extendedAttributes	NA	array(ExtendedAttributeExtIdo)	A collection of extended attributes attached to the line item. This must be the entire set of extended attributes to associate to the line item.

Table 6-14 UinExtIdo— Object

Element Name

Required

Data Type/Example

uin

NA

string($text128) example: 20343932434

The universal identifier number.

status

NA

number($int2) example: 1

The status of the UIN. Valid values are:

1 - In Stock

2 - Sold

3 - Shipped To Warehouse

4 - Shipped To Store

5 - Reserved For Shipping

6 - Shipped To Vender

7 - Removed From Inventory

8 - Unavailable

9 - Missing

10 - In Receiving

11 - Customer Order Reserved

12 - Customer Order Fulfilled

13 - shipped To Finisher

99 - Unconfirmed

Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 99 ]

For more information about the ExtendedAttributeExtIdo object, see the ExtendedAttributeExtIdo - Object section.

For more information about the ExtendedAttributeExtIdo object, see the ExtendedAttributeValueExtIdo - Object section.

Responses

This section describes the responses of the Receipt Confirmed API.

Response Code: 204

No content.

Integration of Direct From Vendor Return

When a vendor return is altered such as when it is approved or closed, or a vendor delivery receipt is made against the vendor return document, EICS will publish the updated vendor return to the service endpoint. The service must be configured on the external services administration screen.

REST Service: Vendor Return (External)

This service publishes out the information about a vendor return (RTV) to an external endpoint. This occurs when the vendor delivery receipt is confirmed.

Update Return

A notification of an updated return is sent when the vendor return is approved, closed, or otherwise modified.

Method

POST

URL

/vendorreturns

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the vendor return that was update.

Example Value

{
  "supplierId": 5510,
  "storeId": 5000,
  "receiptNumber": "A3DA",
  "invoiceNumber": "1004728342",
  "invoiceDate": "2026-02-24T13:44:20.044Z",
  "receiptDate": "2026-02-24T13:44:20.044Z",
  "deliveryType": 1,
  "originatingCountryCode": "CAN",
  "currencyCode": "CAD",
  "carrierCode": "SHP",
  "containers": [
    {
      "cartonId": 55001234,
      "externalCartonId": "234342",
      "trackingNumber": "863413410",
      "receiptDate": "2026-02-24T13:44:20.044Z",
      "adjusted": false,
      "missing": false,
      "items": [
        {
          "itemId": "55001234",
          "vendorProductNumber": "55001234",
          "quantityExpected": 10,
          "quantityReceived": 10,
          "quantityDamaged": 5,
          "caseSize": 100,
          "purchaseOrderId": 7444567333,
          "externalPurchaseOrderId": "55001234",
          "customerOrderNumber": "143523465425",
          "fulfillmentOrderNumber": "134314",
          "unitCostValue": 11.5,
          "uins": [
            {
              "uin": "20343932434",
              "status": 1
            }
          ],
          "extendedAttributes": [
            {
              "generatedBarcode": "(01)12345678901234(15)20251105",
              "quantity": 22,
              "values": [
                {
                  "code": "15",
                  "externalCode": "15",
                  "valueDate": "2026-02-24T13:44:20.044Z",
                  "valueLong": 678334324,
                  "valueDecimal": 1488.99,
                  "valueText": "12365478943255"
                }
              ]
            }
          ]
        }
      ]
    }
  ]

Schema — VendorReturnExtIdo

Table 6-15 VendorReturnExtIdo — Object

Element Name	Required	Data Type/Example	Description
vendorReturnId	NA	number($int15) example: 222345666	The internal system identifier of the vendor return.
externalReturnId	NA	string($text128) example: 76544400	The external identifier of the vendor return from the originating system.
storeId	NA	number($int10) example: 5000	The identifier of the store shipping the return.
supplierId	NA	number($int10) example: 5510	The identifier of the supplier receiving the return.
authorizationCode	NA	string($text12) example: A3DA	A vendor authorization code for the return.
supplierAddress1	NA	string($text240) example: Shipping Company	The first line of the supplier return address.
supplierAddress2	NA	string($text240) example: Suite 100	The second line of the supplier address.
supplierAddress3	NA	string($text240) example: Business Lane	The third line of the supplier return address.
supplierCity	NA	string($text129) example: Nowheresville	The city of the supplier return address.
supplierState	NA	string($text3) example: MN	The state of the supplier return address.
supplierCountry	NA	string($text3) example: USA	The country code of the supplier return address.
supplierPostalCode	NA	string($text30) example: 12345	The postal code of the supplier return address.
status	NA	number($int2) example: 1	The status of the return. Valid values are: 1 - Approved 2 - In Shipping 3 - Shipped 4 - Rejected 5 - Closed Enum: [ 1, 2, 3, 4, 5 ]
createDate	NA	string($date-time)	The date the vendor return was created.
approvedDate	NA	string($date-time)	The date the vendor return was approved.
lineItems	NA	object	A collection of line items on the vendor return.

Table 6-16 VendorReturnItemExtIdo — Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
externalLineNumber	NA	number($int15) example: 2	The external line number.
quantityRequested	NA	number($decimal(20,4)) example: 10	The quantity originally requested.
quantityApproved	NA	number($decimal(20,4)) example: 10	The quantity approved.
quantityInShipping	NA	number($decimal(20,4)) example: 5	The quantity currently in picking/shipping.
quantityShipped	NA	number($decimal(20,4)) example: 5	The quantity shipped.
caseSize	NA	number($decimal(10,4)) example: 100	The case size of the item on this shipment.
unavailableInventory	NA	boolean example: false	True if this item is using unavailable inventory, false otherwise.
returnReason	NA	string($text5) example: O	The shipment return reason code.

Responses

This section describes the responses of the Update Return API.

Response Code: 204

No content.

Integration of Fiscal Documents

An E*Waybill (Electronic Waybill) is an electronically generated document required for the movement of goods above a certain value, typically as mandated by government tax authorities. It serves as a compliance mechanism to ensure that goods being transported have a valid record, thereby preventing tax evasion.

EICS publishes out an Electronic Waybill (sometimes described as a fiscal document) updates to an external endpoint when the Electronic Waybill is first requested or if that request is cancelled. The service must be configured on the external services administration screen.

REST Service: Fiscal Document (External)

An E*Waybill (Electronic Waybill) is an electronically generated document required for the movement of goods above a certain value, typically as mandated by government tax authorities. It serves as a compliance mechanism to ensure that goods being transported have a valid record, thereby preventing tax evasion.

This service must be implemented by an external system that wants to receive notices from EICS about fiscal documents.

Document Requested

This section describes the Document Requested API. This operation will be accessed when SIOCS requests approval of a fiscal document.

Method

POST

URL

/fiscaldocument/request

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the shipment that needs fiscal document approval.

Example Value

{
  "shipmentId": 34134134,
  "shipmentType": 1,
  "documentType": "WBL",
  "requestDate": "2025-11-05T00:00:00Z",
  "currencyCode": "USD",
  "printerUri": "http://printer.server/printer.address/printername",
  "sourceLocationType": 1,
  "sourceLocationId": 34134,
  "destinationLocationType": 1,
  "destinationId": 9834123,
  "billOfLadingId": 46724524,
  "carrierCode": "DF",
  "carrierServiceCode": "2Day",
  "weight": 200,
  "weightUom": "LBS",
  "vehicleRegistrationNumber": "3034654334",
  "vehicleStateOrCountry": "USA",
  "driverName": "John Smith",
  "driverLicenseNumber": "1384713",
  "createUser": "john.smith",
  "createDate": "2025-11-05T00:00:00Z",
  "updateUser": "john.smith",
  "updateDate": "2025-11-05T00:00:00Z",
  "cartons": [
    {
      "containerId": 31413414,
      "externalContainerId": "DR65365356D123",
      "containerWeight": 14.51,
      "containerWeightUom": "LBS",
      "trackingNumber": "65365356JKL123",
      "lineItems": [
        {
          "itemId": "19834",
          "quantity": 112233,
          "preferredUom": "KG",
          "orderLineNumber": 3,
          "documentId": 34134,
          "customerOrderNumber": "13984134",
          "fulfillmentOrderNumber": "34314",
          "unavailable": false,
          "uins": [
            {
              "uin": "20343932434",
              "status": 1
            }
          ],
          "extendedAttributes": [
            {
              "barcode": "389173431734713",
              "quantity": 1,
              "attributes": [
                {
                  "gs1Code": "00",
                  "dateValue": "2025-11-05T00:00:00Z",
                  "longValue": 18374108,
                  "decimalValue": 100.12,
                  "textValue": "Yellow"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "customAttributes": [
    {
      "adminId": 83927,
      "publishCode": "AXS",
      "dataType": 1,
      "dateValue": "2025-11-05T00:00:00Z",
      "longValue": 18374108,
      "decimalValue": 100.12,
      "textValue": "Yellow",
      "dropDownCode": "SKA"
    }
  ]
}

Schema - FiscalDocumentRequestExtIdo

Table 6-17 FiscalDocumentRequestExtIdo - Object

Element Name	Required	Data Type/Example	Description
shipmentId	Yes	integer($int15)	The unique identifier of the shipment.
shipmentType	Yes	integer($int2) example: 1	The type of shipment occurring. Valid values are 1 - Transfer Shipment; 2 - Vendor Return Shipment; 3 - Customer Order Shipment.
documentType	No	string($text6) example: WBL	Publishes the fiscal document type configured in store configuration.
requestDate	No	string($date-time)	The date the fiscal document is requested.
currencyCode	No	string($text3) example: USD	The currency code associated to this shipment.
printerUri	No	string($text128) example: http://printer.server/printer.address/printername	The URI of the printer where the fiscal document should be printed.
sourceLocationType	Yes	integer($int2) example: 1	The location type of the source shipping the goods. Valid values are 1 - Store; 2 - Warehouse; 3 - Finisher; 4 - Supplier.
sourceLocationId	Yes	number($int15) example: 34134	The unique identifier of the source shipping the goods.
destinationLocationType	Yes	integer($int2) example: 1	The location type of the destination receiving the goods. Valid values are 1 - Store; 2 - Warehouse; 3 - Finisher; 4 - Supplier; 5 - Customer.
destinationId	Yes	number($int15) example: 9834123	The unique identifier of the destination receiving the goods.
billOfLadingId	No	integer($int12) example: 46724524	The identifier of the bill of lading.
carrierCode	No	string($text4) example: DF	The carrier code of the shipment carrier.
carrierServiceCode	No	string($text6) example: 2Day	The carrier service code of the service being used.
weight	No	number($decimal(12,4)) example: 200	The weight of the shipment.
weightUom	No	string($text4) example: LBS	The unit of measure of the weight of the shipment.
vehicleRegistrationNumber	No	string($text25) example: 3034654334	The vehicle registration number.
vehicleStateOrCountry	No	string($text25) example: USA	The vehicle state or country of registration.
driverName	No	string($text30) example: John Smith	The driver name.
driverLicenseNumber	No	string($text30) example: 1384713	The driver's liscence number.
createUser	Yes	string($text128) example: john.smith	The user that create the shipment.
createDate	Yes	string($date-time)	The date the shipment was created.
updateUser	Yes	string($text128) example: john.smith	The user that last updated the shipment.
updateDate	Yes	string($date-time)	The date the shipment was last updated.
cartons	Yes	array(FiscalDocumentRequestCartonExtIdo)	The cartons that are shipped within this shipment.
customAttributes	No	array(CustomAttributeExtIdo)	Custom attributes assigned at the shipment level.

Table 6-18 FiscalDocumentRequestCartonExtIdo - Object

Element Name	Required	Data Type/Example	Description
containerId	Yes	integer($int15) example: 31413414	The container identifier.
externalContainerId	No	string($text128) example: DR65365356D123	An identifier assigned to the container from an external system.
containerWeight	No	number($decimal(12,4)) example: 14.51	The weight of the container.
containerWeightUom	No	string($text4) example: LBS	The unit of measure of the container weight.
trackingNumber	No	string($text128) example: 65365356JKL123	A tracking number associated to the container.
lineItems	Yes	array(FiscalDocumentRequestLineItemExtIdo)	The collection of line items that are part of this container.

Table 6-19 FiscalDocumentRequestLineItemExtIdo - Object

Element Name	Required	Data Type/Example	Description
itemId	Yes	string($text25) example: 19834	The item identifier of the item being shipped.
quantity	Yes	number($decimal(20,4)) example: 112233	The quantity being shipped.
preferredUom	No	string($text4) example: KG	The preferred unit of measure of the item for this order.
orderLineNumber	No	integer($int10) example: 3	The sequence order line number if this is a customer order.
documentId	Yes	integer($int12) example: 34134	The identifier of a document associated to the shipment. The type of document is determined by the shipment type.
customerOrderNumber	No	string($text128) example: 13984134	The customer order number associated to this shipment.
fulfillmentOrderNumber	No	string($text128) example: 34314	The fulfillment order number associated to this shipment.
unavailable	Yes	boolean example: false	True if unavailable inventory is being used, false otherwise.
uins	No	array(UinExtIdo)	An array of the UINs associated to this shipment.
extendedAttributes	No	array(ExtendedAttributeExtIdo)	An array of Extended Attributes captured for this item as part of the shipment.

Table 6-20 UinExtIdo - Object

Element Name	Required	Data Type/Example	Description
uin	Yes	string($text128) example: 20343932434	The universal identifier number.
status	Yes	number($int2) example: 1	The status of the UIN. Valid values are 1 - In Stock; 2 - Sold; 3 - Shipped To Warehouse; 4 - Shipped To Store; 5 - Reserved For Shipping; 6 - Shipped To Vender; 7 - Removed From Inventory; 8 - Unavailable; 9 - Missing; 10 - In Receiving; 11 - Customer Order Reserved; 12 - Customer Order Fulfilled; 13 - shipped To Finisher; 99 - Unconfirmed.

For more information about the ExtendedAttributeExtIdo object, see the ExtendedAttributeExtIdo - Object section.

For more information about the ExtendedAttributeExtIdo object, see the ExtendedAttributeValueExtIdo - Object section.

For more information about the CustomAttributeExtIdo object, see the CustomAttributeExtIdo - Object section.

Responses

This section describes the responses of the Document Requested API.

Response Code: 204

No content.

Document Canceled

This section describes the Document Canceled API. This operation will be accessed if SIOCS cancels the fiscal document request sending a notification of that cancellation.

Method

POST

URL

/fiscaldocument/cancel

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the fiscal document that was cancelled.

Example Value

{
  "shipmentId": 112233,
  "shipmentType": 1,
  "documentType": "WBL",
  "documentRequestId": 1384713
}

Schema - FiscalDocumentCancelExtIdo

Table 6-21 FiscalDocumentCancelExtIdo - Object

Element Name	Required	Data Type/Example	Description
shipmentId	Yes	integer($int15) example: 112233	The unique identifier of the shipment.
shipmentType	Yes	integer($int4) example: 1	The type of shipment occurring. Valid values are 1 - Transfer Shipment; 2 - Vendor Return Shipment; 3 - Customer Order Shipment.
documentType	No	string($text6) example: WBL	Publishes the fiscal document type configured in store configuration.
documentRequestId	Yes	number($int20) example: 1384713	The identifier of the request to approve a fiscal document.

Responses

This section describes the responses of the Document Canceled API.

Response Code: 204

No content.

Integration to Fiscal Document

A Nota Fiscal is an official electronic tax document used in countries such as Brazil to record the sale, transfer, or movement of goods and services. It serves as both a commercial invoice and a tax document, containing details about the buyer, seller, products or services, applicable taxes, and transaction value. Issued in standardized electronic formats and validated by government tax authorities, a Nota Fiscal helps ensure tax compliance, supports financial reporting, and provides a legally recognized record of business transactions.

An E-Way Bill (Electronic Way Bill) is a digital document that authorizes and tracks the movement of goods during transportation. Commonly used in countries such as India, it contains information about the shipment, including the consignor, consignee, transporter, origin, destination, and goods being transported. The E-Way Bill is generated electronically before or during transit and is used by tax authorities to verify that goods are being transported in accordance with applicable tax regulations.

While both documents support regulatory compliance, they serve different purposes. A Nota Fiscal primarily documents the commercial transaction and associated tax obligations, whereas an E-Way Bill focuses on the physical movement of goods through the supply chain. In many business processes, the two documents are closely linked, with the E-Way Bill being generated based on information contained in the corresponding invoice or tax document.

REST Service: Fiscal Document

An E*Waybill (Electronic Waybill) is an electronically generated document required for the movement of goods above a certain value, typically as mandated by government tax authorities. It serves as a compliance mechanism to ensure that goods being transported have a valid record, thereby preventing tax evasion.This service must be implemented by an external system that wants to receive notices from EICS about fiscal documents.

Document Requested

This operations will be accessed when SIOCS requests approval of a fiscal document.

Method

POST

URL

/fiscaldocument/request

Request

There are no request parameters.

The request body is application/json.

Details about the shipment that needs fiscal document approval.

Example Value

{
  "shipmentId": 34134134,
  "shipmentType": 1,
  "documentType": "WBL",
  "requestDate": "2026-01-23T09:51:47.134Z",
  "currencyCode": "USD",
  "printerUri": "http://printer.server/printer.address/printername",
  "sourceLocationType": 1,
  "sourceLocationId": 34134,
  "destinationLocationType": 1,
  "destinationId": 9834123,
  "billOfLadingId": 46724524,
  "carrierCode": "DF",
  "carrierServiceCode": "2Day",
  "weight": 200,
  "weightUom": "LBS",
  "vehicleRegistrationNumber": "3034654334",
  "vehicleStateOrCountry": "USA",
  "driverName": "John Smith",
  "driverLicenseNumber": "1384713",
  "createUser": "john.smith",
  "createDate": "2026-01-23T09:51:47.134Z",
  "updateUser": "john.smith",
  "updateDate": "2026-01-23T09:51:47.134Z",
  "cartons": [
    {
      "containerId": 31413414,
      "externalContainerId": "DR65365356D123",
      "containerWeight": 14.51,
      "containerWeightUom": "LBS",
      "trackingNumber": "65365356JKL123",
      "lineItems": [
        {
          "itemId": "19834",
          "quantity": 112233,
          "preferredUom": "KG",
          "orderLineNumber": 3,
          "documentId": 34134,
          "customerOrderNumber": "13984134",
          "fulfillmentOrderNumber": "34314",
          "unavailable": false,
          "uins": [
            {
              "uin": "20343932434",
              "status": 1
            }
          ],
          "extendedAttributes": [
            {
              "barcode": "389173431734713",
              "quantity": 1,
              "attributes": [
                {
                  "gs1Code": "0",
                  "dateValue": "2026-01-23T09:51:47.134Z",
                  "longValue": 18374108,
                  "decimalValue": 100.12,
                  "textValue": "Yellow"
                }
              ]
            }
          ]
        }
      ]
    }
  ],
  "customAttributes": [
    {
      "adminId": 83927,
      "label": "112233",
      "dataType": 1,
      "dateValue": "2026-01-23T09:51:47.134Z",
      "longValue": 18374108,
      "decimalValue": 100.12,
      "textValue": "Yellow"
    }
  ]
}

Schema - FiscalDocumentRequestExtIdo

Table 6-22 FiscalDocumentRequestExtIdo — Object

Element Name	Required	Data Type/Example	Description
shipmentId	Yes	integer($int15) example: 34134134	The unique identifier of the shipment.
shipmentType	Yes	integer($int2) example: 1Enum: [1, 2, 3]	The type of shipment occurring. Valid values are: 1 - Transfer Shipment 2 - Vendor Return Shipment 3 - Customer Order Shipment
documentType	No	string($text6) example: WBL	Publishes the fiscal document type configured in store configuration.
requestDate	No	string($date-time)	The date the fiscal document is requested.
currencyCode	No	string($text3) example: USD	The currency code associated to this shipment.
printerUri	No	string($text128) example: http://printer.server/printer.address/printername	The URI of the printer where the fiscal document should be printed.
sourceLocationType	Yes	integer($int2) example: 1Enum: [1, 2, 3, 4]	The location type of the source shipping the goods. Valid values are: 1 - Store 2 - Warehouse 3 - Finisher 4 - Supplier
sourceLocationId	Yes	number($int15) example: 34134	The unique identifier of the source shipping the goods.
destinationLocationType	Yes	integer($int2) example: 1Enum: [1, 2, 3, 4, 5]	The location type of the destination receiving the goods. Valid values are: 1 - Store 2 - Warehouse 3 - Finisher 4 - Supplier 5 - Customer
destinationId	Yes	number($int15) example: 9834123	The unique identifier of the destination receiving the goods.
billOfLadingId	No	integer($int12) example: 46724524	The identifier of the bill of lading.
carrierCode	No	string($text4) example: DF	The carrier code of the shipment carrier.
carrierServiceCode	No	string($text6) example: 2Day	The carrier service code of the service being used.
weight	No	number($decimal(12,4)) example: 200	The weight of the shipment.
weightUom	No	string($text4) example: LBS	The unit of measure of the weight of the shipment.
vehicleRegistrationNumber	No	string($text25) example: 3034654334	The vehicle registration number.
vehicleStateOrCountry	No	string($text25) example: USA	The vehicle state or country of registration.
driverName	No	string($text30) example: John Smith	The driver name.
driverLicenseNumber	No	string($text30) example: 1384713	The driver's license number.
createUser	Yes	string($text128) example: john.smith	The user that created the shipment.
createDate	Yes	string($date-time)	The date the shipment was created.
updateUser	Yes	string($text128) example: john.smith	The user that last updated the shipment.
updateDate	Yes	string($date-time)	The date the shipment was last updated.
cartons	Yes	object	The cartons that are shipped within this shipment.
customAttributes	No	object	Custom attributes assigned at the shipment level.

Table 6-23 FiscalDocumentRequestCartonExtIdo — Object

Element Name	Required	Data Type/Example	Description
containerId	Yes	integer($int15) example: 31413414	The container identifier.
externalContainerId	No	string($text128) example: DR65365356D123	An identifier assigned to the container from an external system.
containerWeight	No	number($decimal(12,4)) example: 14.51	The weight of the container.
containerWeightUom	No	string($text4) example: LBS	The unit of measure of the container weight.
trackingNumber	No	string($text128) example: 65365356JKL123	A tracking number associated to the container.
lineItems	Yes	object	The collection of line items that are part of this container.

Table 6-24 FiscalDocumentRequestLineItemExtIdo — Object

Element Name	Required	Data Type/Example	Description
itemId	Yes	string($text25) example: 19834	The item identifier of the item being shipped.
quantity	Yes	number($decimal(20,4)) example: 112233	The quantity being shipped.
preferredUom	No	string($text4) example: KG	The preferred unit of measure of the item for this order.
orderLineNumber	No	integer($int10) example: 3	The sequence order line number if this is a customer order.
documentId	Yes	integer($int12) example: 34134	The identifier of a document associated to the shipment. The type of document is determined by the shipment type.
customerOrderNumber	No	string($text128) example: 13984134	The customer order number associated to this shipment.
fulfillmentOrderNumber	No	string($text128) example: 34314	The fulfillment order number associated to this shipment.
unavailable	Yes	boolean example: false	True if unavailable inventory is being used, false otherwise.
uins	No	object	An array of the UINs associated to this shipment.
extendedAttributes	No	object	An array of Extended Attributes captured for this item as part of the shipment.

Table 6-25 UinExtIdo — Object

Element Name

Required

Data Type/Example

Description

uin

Yes

string($text128) example: 20343932434

The universal identifier number.

status

Yes

number($int2) example: 1 Enum: [1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 99]

The status of the UIN. Valid values are:

1 - In Stock

2 – Sold

3 - Shipped To Warehouse

4 - Shipped To Store

5 - Reserved For Shipping

6 - Shipped To Vender

7 - Removed From Inventory

8 – Unavailable

9 – Missing

10 - In Receiving

11 - Customer Order Reserved

12 - Customer Order Fulfilled

13 - shipped To Finisher

99 - Unconfirmed

For more information about the ExtendedAttributeExtIdo object, see the ExtendedAttributeExtIdo - Object section.

For more information about the CustomAttributeExtIdo object, see the CustomAttributeExtIdo - Object section.

For more information about the CustomAttributeValueExtIdo object, see the ExtendedAttributeValueExtIdo - Object section.

Responses

This section describes the responses of the Document Requested API.

Response Code: 204

No content

Document Canceled

This operation will be accessed if SIOCS cancels the fiscal document request sending a notification of that cancellation.

Method

POST

URL

/fiscaldocument/cancel

Request

There are no request parameters.

The request body is application/json.

Details about the fiscal document that was cancelled.

Example Value

{
  "shipmentId": 112233,
  "shipmentType": 1,
  "documentType": "WBL",
  "documentRequestId": 1384713
}

Schema - FiscalDocumentCancelExtIdo

Table 6-26 FiscalDocumentCancelExtIdo — Object

Element Name	Required	Data Type/Example	Description
shipmentId	Yes	integer($int15) example: 112233	The unique identifier of the shipment.
shipmentType	Yes	integer($int4) example: 1 Enum: [1, 2, 3]	The type of shipment occurring. Valid values are: 1 - Transfer Shipment 2 - Vendor Return Shipment 3 - Customer Order Shipment
documentType	No	string($text6) example: WBL	Publishes the fiscal document type configured in store configuration.
documentRequestId	No	number($int20) example: 1384713	The identifier of the request to approve a fiscal document.

Responses

This section describes the responses of the Document Canceled API.

Response Code: 204

No content

Integration of Inventory Movements

EICS publishes out an inventory adjustment when the inventory positions change. This service must be configured on the external services administration screen.

REST Service: Inventory Adjustment (External)

This service publishes out the information about an inventory adjustment to an external endpoint.

Adjustments

Publishes out the information about adjustments.

Method

POST

URL

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the adjustment.

Example Value

{
  "storeId": 5000,
  "transactionType": 1,
  "transactionId": 9834135,
  "adjustments": [
    {
      "itemId": "55001234",
      "quantity": 10,
      "reasonCode": "182",
      "statusCodeFrom": "TRBL",
      "statusCodeTo": "ATS",
      "adjustmentUser": "smith123",
      "adjustmentDate": "2026-02-24T13:30:15.554Z",
      "uins": [
        {
          "uin": "20343932434",
          "status": 1
        }
      ],
      "extendedAttributes": [
        {
          "barcode": "(01)12345678901234(15)20251105",
          "inventoryCode":  (01)12345678901234(10)44444(15)20251105",
          "quantity": 22,
          "values": [
            {
              "code": "15",
              "externalCode": "15",
              "valueDate": "2026-02-24T13:30:15.554Z",
              "valueLong": 678334324,
              "valueDecimal": 1488.99,
              "valueText": "12365478943255"
            }
          ]
        }
      ]
    }
  ]

Schema — InvAdjustmentExtIdo

Table 6-27 InvAdjustmentExtIdo— Object

Element Name	Required	Data Type/Example	Description
storeId	NA	number($int10) example: 5000	The identifier of the store shipping the goods.
transactionType	NA	number($int2) example: 1	The transaction type of a transaction associated to the adjustments. Valid values are: 1 - Auto Adjustment 2 - DSD Receiving 3 - Inventory Adjustmnet 4 - Point Of Sale 5 - RFID 6 - Stock Count Enum: [ 1, 2, 3, 4, 5, 6 ]
transactionId	NA	number($int15) example: 9834135	The transaction identifier of a transaction associated to (or responsible for the create of) the adjustments. This will only be present if the adjustments all derive from the same transaction.
adjustments	NA	object	A collection of adjustments

Table 6-28 InvAdjustmentItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
quantity	NA	number($decimal(20,4)) example: 10	The quantity of the adjustment.
reasonCode	NA	string($text4) example: 182	The reason code for the adjustment.
statusCodeFrom	NA	string($text4) example: TRBL	The inventory disposition status is moved from.
statusCodeTo	NA	string($text4) example: ATS	The inventory disposition status is moved to.
adjustmentUser	NA	string($text128) example: smith123	The user that confirmed the adjustment or transaction.
adjustmentDate	NA	string($date-time)	The date of the adjustment.
uins	NA	object	A collection of line items on the vendor return.
extendedAttributes	NA	array(ExtendedAttributeExtIdo)	A collection of extended attributes attached to the line item. This must be the entire set of extended attributes to associate to the line item.

Table 6-29 UinExtIdo— Object

Element Name

Required

Data Type/Example

uin

NA

string($text128) example: 20343932434

The universal identifier number.

status

NA

number($int2) example: 1

The status of the UIN. Valid values are:

1 - In Stock

2 - Sold

3 - Shipped To Warehouse

4 - Shipped To Store

5 - Reserved For Shipping

6 - Shipped To Vender

7 - Removed From Inventory

8 - Unavailable

9 - Missing

10 - In Receiving

11 - Customer Order Reserved

12 - Customer Order Fulfilled

13 - shipped To Finisher

99 - Unconfirmed

Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 99 ]

For more information about the ExtendedAttributeExtIdo object, see the ExtendedAttributeExtIdo - Object section.

For more information about the ExtendedAttributeExtIdo object, see the ExtendedAttributeValueExtIdo - Object section.

Responses

This section describes the responses of the Adjustments API.

Response Code: 204

No content.

Integration with Manifesting Systems

In order for access to an external manifesting system to take place, the customer must first setup Carrier Type as "Third Party" and the Carrier Service (Manifest Type) must be Parcel (P). Configuration controls whether manifesting is done for a transfer to store, finisher, or warehouse. In addition, configuration controls manifesting for a return to vendor shipment or a customer order delivery.

Carrier services with manifest type of "O" (Other) and "H" (Home Fleet) do not go through the manifesting system. When Manifest Type is "O," EICS prompts the user to enter the carrier address where the shipment is to be sent for fulfillment. Manifest Type of "H" is within the company and therefore, does not prompt the user for an address.

Some carriers require weight, dimension, or both values to be sent in the manifest payload. If so, the carrier's service should have either the weight indicator or carton dimension indicate set to active (or both) during their carrier service setup.

EICS supplies an outbound and inbound Shipment Manifest REST web service.

A web service is used to send all the shipment information to the external manifesting system and also to receive close shipment requests from external systems.

A web service accepts requests from external systems to close shipments. It is used to find those "Submitted" shipments for the provided tracking ID, carrier, service and date, and dispatch those shipments.

REST Service: Manifest

This is a manifest service integration definition. This service must be implemented by an external system that wants to receive manifesting calls from EICS in order to manifest a shipment. EICS will send all the shipping information to this service and receive back basic tracking information for the shipment. In order for access to an external manifesting system to take place, the customer must first setup Carrier Type as "Third Party" and the Carrier Service (Manifest Type) must be Parcel (P). Configuration controls whether manifesting is done for a transfer to store, finisher, or warehouse. In addition, configuration controls manifesting for a return to vendor shipment or a customer order delivery. Carrier services with manifest type of "O" (Other) and "H" (Home Fleet) do not go through the manifesting system. When Manifest Type is "O," EICS prompts the user to enter the carrier address where the shipment is to be sent for fulfillment. Manifest Type of "H" is within the company and therefore, does not prompt the user for an address. Some carriers require weight, dimension, or both values to be sent in the manifest payload. If so, the carrier's service should have either the weight indicator or carton dimension indicate set to active (or both) during their carrier service setup.

Obtain Shipment Manifest

Obtain shipment manifest information from the external system.

Method

POST

URL

/manifest

Request Parameters

There are no request parameters.

The request body is application/json.

Example Value

{
  "shipmentType": 1,
  "shipmentId": 11111,
  "storeId": 5000,
  "customerOrderId": "789012",
  "shippingCost": 54.23,
  "shippingCostCurrency": "USD",
  "carrierCode": "UPS",
  "carrierServiceCode": "2DAY",
  "packageHeight": 6,
  "packageWidth": 6,
  "packageLength": 6,
  "packUom": "CM",
  "packageWeight": 5.5,
  "packageWeightUom": "LBS",
  "deliveryDate": "2025-02-07T12:51:37.859Z",
  "printerUri": null,
  "userName": "smith123",
  "storeAddress": {
    "addressType": 1,
    "name": "Jane Smith",
    "address1": "7th Aveneue North",
    "address2": "Baker's Apartment Building",
    "address3": "Apartment 28A",
    "city": "Sunnyside",
    "county": "Vale",
    "stateCode": "WI",
    "countryCode": "USA",
    "postalCode": "55555"
  },
  "storeContact": {
    "firstName": "John",
    "lastName": "Smith",
    "fullName": "John Smith",
    "companyName": "Speedy, Inc.",
    "contactEmail": "john.smith@provider.com",
    "contactFax": "A",
    "contactPhone": "(555) 555-5555",
    "contactPhoneType": 1
  },
  "destinationAddress": {
    "addressType": 1,
    "name": "Jane Smith",
    "address1": "7th Aveneue North",
    "address2": "Baker's Apartment Building",
    "address3": "Apartment 28A",
    "city": "Sunnyside",
    "county": "Vale",
    "stateCode": "WI",
    "countryCode": "USA",
    "postalCode": "55555"
  },
  "destinationContact": {
    "firstName": "John",
    "lastName": "Smith",
    "fullName": "John Smith",
    "companyName": "Speedy, Inc.",
    "contactEmail": "john.smith@provider.com",
    "contactFax": "A",
    "contactPhone": "(555) 555-5555",
    "contactPhoneType": 1
  },
  "billingAddress": {
    "addressType": 1,
    "name": "Jane Smith",
    "address1": "7th Aveneue North",
    "address2": "Baker's Apartment Building",
    "address3": "Apartment 28A",
    "city": "Sunnyside",
    "county": "Vale",
    "stateCode": "WI",
    "countryCode": "USA",
    "postalCode": "55555"
  },
  "billingContact": {
    "firstName": "John",
    "lastName": "Smith",
    "fullName": "John Smith",
    "companyName": "Speedy, Inc.",
    "contactEmail": "john.smith@provider.com",
    "contactFax": "A",
    "contactPhone": "(555) 555-5555",
    "contactPhoneType": 1
  },
  "items": [
    {
      "itemId": "100637445",
      "itemDescription": "Raspberry Tea",
      "quantity": "15.5",
      "unitOfMeasure": "KG"
    }
  ]
}

Schema — ManifestExtIdo

Table 6-30 ManifestExtIdo— Object

Element Name	Required	Data Type/Example	Description
shipmentType	NA	integer($int1) example: 1	The type of shipment. Valid values are: 1 - Fulfillment Order Delivery 2 - Transfer Shipment 3 - Return To Vendor Shipment Enum: [ 1, 2, 3
shipmentId	NA	number($int12) example: 11111	The unique identifier of the vendor shipment.
storeId	NA	number($int10) example: 5000	The identifier of the store shipping the inventory.
customerOrderId	NA	string($text128) example: 789012	The customer order number.
internalCartonId	NA	number($int12) example: 55001234	The system internal container identifier.
externalCartonId	NA	string($text128) example: 234342	An external system carton identifier for reference.
shippingCost	NA	number($decimal(12,4)) example: 54.23	The amount of a delivery charge of the shipment.
shippingCostCurrency	NA	string($text3) example: USD	The currency code of the delivery charge.
carrierCode	NA	string($text4) example: UPS	The carrier code of the carrier being used.
carrierServiceCode	NA	string($text6) example: 2DAY	The carrier service code of the service being used.
packageHeight	NA	number($decimal(12,4)) example: 6	The height of the package in the package unit of measure.
packageWidth	NA	number($decimal(12,4)) example: 6	The width of the package in the package unit of measure.
packageLength	NA	number($decimal(12,4)) example: 6	The length of the package in the package unit of measure.
packUom	NA	string($text4) example: CM	The unit of measure of the package dimensions.
packageWeight	NA	number($decimal(12,4)) example: 5.5	The weight of the package in the weight unit of measure.
packageWeightUom	NA	string($text4) example: LBS	The unit of measure of the package weight.
deliveryDate	NA	string($date-time)	The delivery date of the shipment.
printerUri	NA	string($text300) example: null	The URI of the printer for a manifest.
userName	NA	string($text128) example: smith123	A user associated to the shipment.
storeAddress	NA	object	store address
storeContact	NA	object	store contact
destinationAddress	NA	object	destination address
destinationContact	NA	object	destination contact
billingAddress	NA	object	billing address
billingContact	NA	object	billing contact
items	NA	object	A collection of line items on the shipment.

Table 6-31 ManifestAddressExtIdo — Object

Element Name	Required	Data Type/Example	Description
addressType	NA	integer($int1) example: 1	The type of the address. Valid values are: 1 - Business 2 - Billing 3 - Delivery Enum: [ 1, 2, 3 ]
name	NA	string($text120) example: Jane Smith	The name of the contact at the address.
address1	NA	string($text240) example: 7th Avenue North	The first line of the address.
address2	NA	string($text240) example: Baker's Apartment Building	The second line of the address.
address3	NA	string($text240) example: Apartment 28A	The third line of the address.
city	NA	string($text120) example: Sunnyside	The city of the address.
county	NA	string($text250) example: Vale	The county of the address.
stateCode	NA	string($text3) example: WI	The state code of the address.
countryCode	NA	string($text3) example: USA	The country code of the address.
postalCode	NA	string($text30) example: 55555	The carrier code of the carrier being used. The postal code of the address.

Table 6-32 ManifestContactExtIdo — Object

Element Name	Required	Data Type/Example	Description
firstName	NA	string($text120) example: John	The first name of the contact.
lastName	NA	string($text120) example: Smith	The last name of the contact.
fullName	NA	string($text120) example: John Smith	The full name of the contact.
companyName	NA	string($text120) example: Speedy, Inc.	The company name.
contactEmail	NA	string($text100) example: john.smith@provider.com	The email address of the contact.
contactFax	NA	string($text120) example: A	The fax number of the contact.
contactPhone	NA	string($text20) example: (555) 555-5555	The phone number of the contact.
contactPhoneType	NA	integer($int1) example: 1	The phone type of the phone number. Valid values are: 1 - Voice 2 - Work 3 - Fax Enum: [ 1, 2, 3 ]

Table 6-33 ManifestItemExtIdo — Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 100637445	The SKU number of the item.
itemDescription	NA	string($text400) example: Raspberry Tea	The description of the item.
quantity	NA	string($decimal(20,4)) example: 15.5	The quantity being shipped.
unitOfMeasure	NA	string($text4) example: KG	The unit of measure of the quantity being shipped.

Responses

This section describes the responses of the Obtain Shipment Manifest API.

Response Code: 200

The request has been successful.

The media type is application/json.

Example Value

[
  {
    "shipmentType": 1,
    "shipmentId": 11111,
    "carrierCode": "UPS",
    "carrierServiceCode": "2DAY",
    "carrierTrackingNumber": "AZB100245683"
  }
]

Schema — ManifestTrackExtIdo

Table 6-34 ManifestTrackExtIdo— Object

Element Name	Required	Data Type/Example	Description
shipmentType	NA	integer($int1) example: 1	The type of shipment. Valid values are: 1 - Fulfillment Order Delivery 2 - Transfer Shipment 3 - Return To Vendor Shipment Enum: [ 1, 2, 3 ]
shipmentId	Na	number($int15) example: 11111	The unique identifier of the shipment.
carrierCode	NA	string($text4) example: UPS	The carrier code of the carrier being used.
carrierServiceCode	NA	string($text6) example: 2DAY	The carrier service code of the service being used.
carrierTrackingNumber	NA	string($text128) example: AZB100245683	The tracking number provided by the carrier.

Integration for Notifications

Notifications that are generated by the system can be sent to an external system. The service must be configured on the external services administration screen.

REST Service: Notification (External)

This service publishes out the information about a notification (most often, an event that occurred in the system) to an external endpoint.

Notification

Publishes out the information about a notification.

Method

POST

URL

/notifications

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the notification.

Example Value

{
  "storeId": 5000,
  "name": "Late Delivery",
  "description": "Delivery 123 did not arrive by Tuesday 13th.",
  "createDate": "2025-02-10T11:46:26.867Z",
  "createUser": "System",
  "transactionType": 1,
  "transactionId": 9834135
}

Schema — NotificationExtIdo

Table 6-35 NotificationExtIdo— Object

Element Name	Required	Data Type/Example	Description
storeId	NA	number($int10) example: 5000	The identifier of the store shipping the goods.
name	NA	string($text400) example: Late Delivery	The name, title, or summary text of the notification.
description	NA	string($text2000) example: Delivery 123 did not arrive by Tuesday 13th.	The contents of the notification.
createDate	NA	string($date-time)	The date the notification was created.
createUser	NA	string($text128) example: System	The user that created the notification.
transactionType	NA	number($int2) example:1	The transaction type of the transaction associated to the notification. Valid values are: 1 - Customer Order 2 - Customer Order Pick 3 - Customer Order Delivery 4 - Customer Order Reverse Pick 5 - Direct Store Delivery Receiving 6 - Invenotry Adjustment 7 - Item Basket 8 - Replenishment Gap 9 - Shelf Adjustment 10 - Shelf Replenishment 11 - Stock Count 12 - Store Order 13 - Transfer 14 - Transfer Shipment 15 - Transfer Receiving 16 - Vendor Return 17 - Vendor Return Shipment Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17 ]
transactionId	NA	number($int15) example: 9834135	The transaction identifier of a transaction associated to (or responsible for the create of) the notification.

Responses

This section describes the responses of the Notification API.

Response Code: 204

No content

Integration of Pre-Shipment Notification

A pre-shipment notification contains the same information as a final shipment but is sent in advance of the shipment when the user submits the shipment, if submit and pre-shipment are enabled and configured in the system. EICS publishes this pre-shipment notification to a service endpoint which must be configured on the external service administration screen.

REST Service: Pre-Shipment Notification (External)

This service publishes out the information about an intended shipment prior to its dispatch to an external endpoint.

Pre-Shipment Notice

This section describes the Pre-Shipment Notice API. It publishes out the information about an intended shipment prior to its dispatch.

Method

POST

URL

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the shipment.

Example Value

{
  "shipmentType": 1,
  "storeId": 5000,
  "destinationLocationType": 1,
  "destinationLocationId": "6100",
  "asn": "ABC123456",
  "contextTypeId": 90000,
  "contextTypeCode": "SR",
  "contextValue": "Spring Return",
  "billOfLadingNumber": "AX4234234",
  "addressLine1": "123 Orange Street",
  "addressLine2": "PO Box 1234",
  "addressLine3": "c/o Intake Processing",
  "addressCity": "Nowheresville",
  "addressState": "MN",
  "addressPostalCode": "12345",
  "addressCountryCode": "US",
  "carrierCode": "DF",
  "carrierServiceCode": "2Day",
  "notes": [
    "Rush transfer",
    "Promotional goods"
  ],
  "customAttributes": [
    {
      "adminId": 11111,
      "code": "Green",
      "dataType": 1,
      "dateValue": "2025-11-05T00:00:00Z",
      "longValue": 18374108,
      "decimalValue": 100.12,
      "textValue": "Yellow",
      "dropDownCode": "SKA"
    }
  ],
  "containers": [
    {
      "containerId": "550077733",
      "externalContainerId": 2,
      "containerWeight": 10,
      "containerWeightUom": 10,
      "trackingNumber": "FXD124A3434",
      "customAttributes": [
        {
          "adminId": 11111,
          "code": "Green",
          "dataType": 1,
          "dateValue": "2025-11-05T00:00:00Z",
          "longValue": 18374108,
          "decimalValue": 100.12,
          "textValue": "Yellow",
          "dropDownCode": "SKA"
        }
      ],
      "items": [
        {
          "itemId": "55001234",
          "quantity": 10,
          "documentId": "1234",
          "externalDocumentId": "AGH1434",
          "customerOrderNumber": "5666",
          "fulfillmentOrderNumber": "7888",
          "orderLineNumber": "9",
          "unavailable": "fakse",
          "uins": [
            {
              "uin": "20343932434",
              "status": 1
            }
          ],
          "extendedAttributes": [
            {
              "generatedBarcode": "(01)12345678901234(15)20251105",
              "quantity": 22,
              "values": [
                {
                  "code": "15",
                  "externalCode": "15",
                  "valueDate": "2025-11-05T00:00:00Z",
                  "valueLong": 678334324,
                  "valueDecimal": 1488.99,
                  "valueText": "12365478943255"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Schema - PreShipmentExtIdo

Table 6-36 PreShipmentExtIdo - Object

Element Name	Required	Data Type/Example	Description
shipmentType	NA	number($int2) example: 1	The type of shipment. Valid values are 1 - Fulfillment Order Delivery; 2 - Transfer; 3 - Vendor Return.
storeId	NA	number($int10) example: 5000	The identifier of the store shipping the goods.
destinationLocationType	NA	number($int2) example: 1	The location type of the destination receiving the goods. Valid values are 1 - Store; 2 - Warehouse; 3 - Finisher; 4 - Supplier; 5 - Customer.
destinationLocationId	NA	string($text128) example: 6100	The identifier of the destination location receiving the goods.
asn	NA	string($text128) example: ABC123456	The advanced shipment notification number.
contextTypeId	NA	number($int18) example: 90000	A unique identifier of a context type for the shipment (see shipping service).
contextTypeCode	NA	string($text6) example: SR	The context type code published as part of this context type.
contextValue	NA	string($text25) example: Spring Return	An additional value associated to the context for the shipment.
billOfLadingNumber	NA	string($text128) example: AX4234234	The bill of lading number (or the ASN if no bill of lading exists).
addressLine1	NA	string($text240) example: 123 Orange Street	The first line of the address to ship to.
addressLine2	NA	string($text240) example: PO Box 1234	The second line of the address to ship to.
addressLine3	NA	string($text240) example: c/o Intake Processing	The third line of the address to ship to.
addressCity	NA	string($text120) example: Nowheresville	The city of the address to ship to.
addressState	NA	string($text3) example: MN	The state of the address to ship to.
addressPostalCode	NA	string($text30) example: 12345	The postal code of the address to ship to.
addressCountryCode	NA	string($text3) example: US	The country code of the address to ship to.
carrierCode	NA	string($text4) example: DF	The carrier code of the shipment carrier.
carrierServiceCode	NA	string($text6) example: 2Day	The carrier service code of the service being used.
notes	NA	array(string($text2000)) example: Rush transfer, Promotional goods	The notes associated to this shipment.
customAttributes	NA	array(CustomAttributeExtIdo)	A collection of customer attributes associated to the shipment.
containers	NA	array(PreShipmentContainerExtIdo)	A collection of containers on the shipment.

For more information about the CustomAttributeExtIdo object, see the CustomAttributeExtIdo - Object section.

Table 6-37 PreShipmentContainerExtIdo - Object

Element Name	Required	Data Type/Example	Description
containerId	NA	string($text128) example: 550077733	The container identifier.
externalContainerId	NA	number($int15) example: 2	An external container identifier (possibly capturing a container identifier of an originating system other than SIOCS).
containerWeight	NA	number($decimal(20,4)) example: 10	The weight of the container.
containerWeightUom	NA	number($decimal(20,4)) example: 10	The unit of measure of the weight of the container.
trackingNumber	NA	string($text128) example: FXD124A3434	The tracking number of the container.
customAttributes	NA	array(CustomAttributeExtIdo)	A collection of customer attributes associated to the shipment.
items	NA	array(PreShipmentItemExtIdo)	A collection of items within the container.

Table 6-38 PreShipmentItemExtIdo - Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
quantity	NA	number($decimal(20,4)) example: 10	The quantity being shipped.
documentId	NA	string($text5) example: 1234	The document number of the document associated to this transfer, such as a transfer, allocation, or purchase order.
externalDocumentId	NA	string($text128) example: AGH1434	Contains an external reference document (transfer, vendor return) to the document this item is associated to. This will be empty in the case of a customer order delivery.
customerOrderNumber	NA	string($text5) example: 5666	The identifier of the customer order associated to this line item.
fulfillmentOrderNumber	NA	string($text5) example: 7888	The identifier of the fulfillment order associated to this line item.
orderLineNumber	NA	string($text5) example: 9	A customer order line number associated to this line item.
unavailable	NA	boolean example: fakse	True if this item is using unavailable inventory, false otherwise.
uins	NA	array(UinExtIdo)	A collection of UINs on the pre-shipment notification.
extendedAttributes	NA	array(ExtendedAttributeExtIdo)	A collection of extended attributes attached to the line item.

Table 6-39 UinExtIdo - Object

Element Name	Required	Data Type/Example	Description
uin	NA	string($text128) example: 20343932434	The universal identifier number.
status	NA	number($int2) example: 1	The status of the UIN. Valid values are 1 - In Stock; 2 - Sold; 3 - Shipped To Warehouse; 4 - Shipped To Store; 5 - Reserved For Shipping; 6 - Shipped To Vender; 7 - Removed From Inventory; 8 - Unavailable; 9 - Missing; 10 - In Receiving; 11 - Customer Order Reserved; 12 - Customer Order Fulfilled; 13 - shipped To Finisher; 99 - Unconfirmed.

For more information about the ExtendedAttributeExtIdo object, see the ExtendedAttributeExtIdo - Object section.

For more information about the ExtendedAttributeExtIdo object, see the ExtendedAttributeValueExtIdo - Object section.

Responses

This section describes the responses of the Pre-Shipment Notice API.

Response Code: 204

No content

Integration for Sales Forecast

SIOCS can retrieve sales forecast information about items from the Oracle Statistical Forecasting Engine on the AI Foundation platform. To use this feature, access to the Oracle Forecasting Engine is required. Simply configure the External Service Administration EICS screen property for sales forecast to point to the location where the Oracle forecasting service is deployed.

Integration of Shipments

EICS publishes out a shipment notification (ASN) to an external endpoint when the shipment is confirmed. The service must be configured on the external services administration screen.

REST Service: Shipment Notification (External)

This service is defined to send a notice of a shipment (ASN - Advance Shipment Notification). This indicates the shipment has taken place and the goods are on the way.

Shipment Notice

This section describes the Shipment Notice API. It publishes out the information about a shipment.

Method

POST

URL

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the shipment.

Example Value

{
  "shipmentType": 1,
  "storeId": 5000,
  "destinationLocationType": 1,
  "destinationLocationId": "6100",
  "asn": "ABC123456",
  "contextTypeId": 90000,
  "contextTypeCode": "SR",
  "contextValue": "Spring Return",
  "billOfLadingNumber": "AX4234234",
  "dispatchDate": "2025-11-05T00:00:00Z",
  "addressLine1": "123 Orange Street",
  "addressLine2": "PO Box 1234",
  "addressLine3": "c/o Intake Processing",
  "addressCity": "Nowheresville",
  "addressState": "MN",
  "addressPostalCode": "12345",
  "addressCountryCode": "US",
  "carrierCode": "DF",
  "carrierServiceCode": "2Day",
  "notes": [
    "Rush transfer",
    "Promotional goods"
  ],
  "customAttributes": [
    {
      "adminId": 11111,
      "code": "Green",
      "dataType": 1,
      "dateValue": "2025-11-05T00:00:00Z",
      "longValue": 18374108,
      "decimalValue": 100.12,
      "textValue": "Yellow",
      "dropDownCode": "SKA"
    }
  ],
  "containers": [
    {
      "containerId": 550077733,
      "externalContainerId": "23483431",
      "containerWeight": 10,
      "containerWeightUom": "LB",
      "trackingNumber": "FXD124A3434",
      "customAttributes": [
        {
          "adminId": 11111,
          "code": "Green",
          "dataType": 1,
          "dateValue": "2025-11-05T00:00:00Z",
          "longValue": 18374108,
          "decimalValue": 100.12,
          "textValue": "Yellow",
          "dropDownCode": "SKA"
        }
      ],
      "items": [
        {
          "itemId": "55001234",
          "quantity": 10,
          "documentId": 138413,
          "externalDocumentId": "AGH1434",
          "customerOrderNumber": "934134",
          "fulfillmentOrderNumber": "43534134",
          "orderLineNumber": 1,
          "reasonCode": "O",
          "unavailable": "fakse",
          "uins": [
            {
              "uin": "20343932434",
              "status": 1
            }
          ],
          "extendedAttributes": [
            {
              "generatedBarcode": "(01)12345678901234(15)20251105",
              "quantity": 22,
              "values": [
                {
                  "code": "15",
                  "externalCode": "15",
                  "valueDate": "2025-11-05T00:00:00Z",
                  "valueLong": 678334324,
                  "valueDecimal": 1488.99,
                  "valueText": "12365478943255"
                }
              ]
            }
          ]
        }
      ]
    }
  ]
}

Schema - ShipmentExtIdo

Table 6-40 ShipmentExtIdo - Object

Element Name	Required	Data Type/Example	Description
shipmentType	NA	number($int2) example: 1	The type of shipment. Valid values are 1 - Fulfillment Order Delivery; 2 - Transfer; 3 - Vendor Return.
storeId	NA	number($int10) example: 5000	The identifier of the store shipping the goods.
destinationLocationType	NA	number($int2) example: 1	The location type of the destination receiving the goods. Valid values are 1 - Store; 2 - Warehouse; 3 - Finisher; 4 - Supplier; 5 - Customer.
destinationLocationId	NA	string($text128) example: 6100	The identifier of the destination location receiving the goods.
asn	NA	string($text128) example: ABC123456	The advanced shipment notification number.
contextTypeId	NA	number($int18) example: 90000	A unique identifier of a context type for the shipment (see shipping service).
contextTypeCode	NA	string($text6) example: SR	The context type code published as part of this context type.
contextValue	NA	string($text25) example: Spring Return	An additional value associated to the context for the shipment.
billOfLadingNumber	NA	string($text128) example: AX4234234	The bill of lading number (or the ASN if no bill of lading exists).
dispatchDate	NA	string($date-time)	The date the shipment was dispatched.
addressLine1	NA	string($text240) example: 123 Orange Street	The first line of the address to ship to.
addressLine2	NA	string($text240) example: PO Box 1234	The second line of the address to ship to.
addressLine3	NA	string($text240) example: c/o Intake Processing	The third line of the address to ship to.
addressCity	NA	string($text120) example: Nowheresville	The city of the address to ship to.
addressState	NA	string($text3) example: MN	The state of the address to ship to.
addressPostalCode	NA	string($text30) example: 12345	The postal code of the address to ship to.
addressCountryCode	NA	string($text3) example: US	The country code of the address to ship to.
carrierCode	NA	string($text4) example: DF	The carrier code of the shipment carrier.
carrierServiceCode	NA	string($text6) example: 2Day	The carrier service code of the service being used.
notes	NA	array(string($text2000)) example: Rush transfer, Promotional goods	The notes associated to this shipment.
customAttributes	NA	array(CustomAttributeExtIdo)	A collection of customer attributes associated to the shipment.
containers	NA	array(ShipmentContainerExtIdo)	A collection of containers on the shipment.

For more information about the CustomAttributeExtIdo object, see the CustomAttributeExtIdo - Object section.

Table 6-41 ShipmentContainerExtIdo - Object

Element Name	Required	Data Type/Example	Description
containerId	NA	number($int15) example: 550077733	The container identifier.
externalContainerId	NA	string($text128) example: 23483431	The identifier of the container if it originated in an external system.
containerWeight	NA	number($decimal(12,4)) example: 10	The weight of the container.
containerWeightUom	NA	string($text4) example: LB	The unit of measure of the weight of the container.
trackingNumber	NA	string($text128) example: FXD124A3434	The tracking number of the container.
customAttributes	NA	array(CustomAttributeExtIdo)	A collection of customer attributes associated to the carton.
items	NA	array(ShipmentItemExtIdo)	A collection of items within the container.

Table 6-42 ShipmentItemExtIdo - Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
quantity	NA	number($decimal(20,4)) example: 10	The quantity that was shipped.
documentId	NA	number($int15) example: 138413	The identifier of a document (transfer, vendor return) it is associated to.
externalDocumentId	NA	string($text128) example: AGH1434	Contains an external reference document (transfer, vendor return) to the document this item is associated to. This will be empty in the case of a customer order delivery.
customerOrderNumber	NA	string($text128) example: 934134	A customer order number of a customer order associated to the line item.
fulfillmentOrderNumber	NA	string($text128) example: 43534134	A fulfillment order number of a customer order fulfillment associated to the line item.
orderLineNumber	NA	number($int15) example: 1	The order line number of this item on the customer order.
reasonCode	NA	string($text5) example: O	The shipment reason code.
unavailable	NA	boolean example: fakse	True if this item is using unavailable inventory, false otherwise.
uins	NA	array(UinExtIdo)	A collection of UINs for this item.
extendedAttributes	NA	array(ExtendedAttributeExtIdo)	A collection of extended attributes attached to the line item.

Table 6-43 UinExtIdo - Object

Element Name	Required	Data Type/Example	Description
uin	NA	string($text128) example: 20343932434	The universal identifier number.
status	NA	number($int2) example: 1	The status of the UIN. Valid values are 1 - In Stock; 2 - Sold; 3 - Shipped To Warehouse; 4 - Shipped To Store; 5 - Reserved For Shipping; 6 - Shipped To Vender; 7 - Removed From Inventory; 8 - Unavailable; 9 - Missing; 10 - In Receiving; 11 - Customer Order Reserved; 12 - Customer Order Fulfilled; 13 - shipped To Finisher; 99 - Unconfirmed.

For more information about the ExtendedAttributeExtIdo object, see the ExtendedAttributeExtIdo - Object section.

For more information about the ExtendedAttributeExtIdo object, see the ExtendedAttributeValueExtIdo - Object section.

Responses

This section describes the responses of the Shipment Notice API.

Response Code: 204

No content.

Integration of Stock Count Schedules

With the product group schedule administration screen, you can create, update, and cancel a unit and amount stock count schedule. When you do so, EICS will publish information about that schedule to an external service endpoint if configured on the external service administration screen.

REST Service: Stock Count Schedule (External)

This service publishes out the information about a stock count schedule to an external endpoint. This occurs whenever the state of the schedule is altered.

Schedule Updated

This service will be accessed when the stock count schedule is updated.

Method

POST

URL

/countschedules

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the stock count schedule that was updated.

Example Value

{
  "scheduleId": 123343434,
  "description": "Monthly Count",
  "startDate": "2025-04-15T11:56:27.545Z",
  "allItems": false,
  "storeIds": [
    5000,
    5010
  ],
  "hierarchies": [
    {
      "departmentId": 1000,
      "classId": 2000,
      "subclassId": 3000
    }
  ]
}

Schema — StockCountScheduleExtIdo

Table 6-44 StockCountScheduleExtIdo - Object

Element Name	Required	Data Type/Example	Description
scheduleId	NA	number($int8) example: 123343434	The identifier of the stock count schedule.
description	NA	string($text250) example: Monthly Count	The description of the stock count schedule.
startDate	NA	string($date-time)	The date of the stock count.
allItems	NA	boolean example: false	True, if the schedule represents an all-item count, false if it represents a hierarchy count.
storeIds	NA	number($int10)] example: List [ 5000, 5010 ]	The store identifiers associated to the stock count schedule
hierarchies	NA	object	A collection of hierarchies the stock count is for.

Table 6-45 StockCountScheduleHierarchyExtIdo - Object

Element Name	Required	Data Type/Example	Description
departmentId	NA	number($int12) example: 1000	The department identifier.
classId	NA	number($int12) example: 2000	The class identifier.
subclassId	NA	number($int12) example: 3000	The subclass identifier.

Responses

This section describes the responses of the Schedule Updated API.

Response Code: 204

No content.

Schedule Canceled

This service will be accessed when the stock count schedule itself is cancelled.

Method

POST

URL

/delete/{scheduleId}

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the stock count schedule that was canceled.

Example Value

{
"scheduleId": 123343434, 
"description": "Monthly Count",
"startDate": "2025-04-15T11:56:27.545Z",
"allItems": false,
"storeIds": [
  5000,
  5010
],
"hierarchies": [
  {
    "departmentId": 1000, 
    "classId": 2000,
    "subclassId": 3000
   }
  ]
 }

Schema — StockCountScheduleCancelExtIdo

Table 6-46 StockCountScheduleCancelExtIdo - Object

Element Name	Required	Data Type/Example	Description
scheduleId	NA	number($int8) example: 123343434	The identifier of the stock count schedule.
description	NA	string($text250) example: Monthly Count	The description of the stock count schedule.
startDate	NA	string($date-time)	The date of the stock count.

Responses

This section describes the responses of the Schedule Canceled API.

Response Code: 204

No content.

Integration for Store Order

When either a store order is approved in EICS, or when a new store order is created by EICS (either manually or system generated), a notification to a third-party item management can be sent. The endpoint service must be configured in the external service configuration administration screen. EICS does not send newly created store order notification for store orders created by an external system.

REST Service: Store Order (External)

Service has operations for both approval and create notifications.

Approve Order

A notification that a store order generated in an external system has been approved by the store.

Method

POST

URL

/storeorders/approvals

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the store order that was approved.

Example Value

{
  "orderId": 222345666,
  "storeId": 5000,
  "externalTransferId": "7000",
  "externalPurchaseOrderId": "8000",
  "requestedDeliveryDate": "2025-02-10T14:37:45.178Z",
  "approvedDate": "2025-02-10T14:37:45.178Z",
  "lineItems": [
    {
      "itemId": "55001234",
      "quantity": 5
    }
  ]
}

Schema — StoreOrderApproveExtIdo

Table 6-47 StoreOrderApproveExtIdo— Object

Element Name	Required	Data Type/Example	Description
orderId	NA	number($int15) example: 222345666	The internal system identifier of the store order.
storeId	NA	number($int10) example: 5000	The identifier of the store that will receive the goods.
externalTransferId	NA	string($text128) example: 7000	An external transfer identifier that this store order is associated to if it is a transfer approval (from a warehouse).
externalPurchaseOrderId	NA	string($text128) example: 8000	An external purchase order identifier that this store order is associated to if it is a purchase order approval (from a supplier).
requestedDeliveryDate	NA	string($date-time)	The date the goods should be delivered.
approvedDate	NA	string($date-time)	The date the store order was approved by the store.
lineItems	NA	object	A collection of line items on the store order.

Table 6-48 StoreOrderApproveItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
quantity	NA	number($decimal(20,4)) example: 5	The quantity approved.

Responses

This section describes the responses of the Approve Order API.

Response Code: 204

No content

Request Order

A notification of a request to generate a new order for goods.

Method

POST

URL

/storeorders/requests

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the store order that is being requested.

Example Value


  "orderId": 222345666,
  "storeId": 5000,
  "restrictSupplierId": 7000,
  "restrictWarehouseId": 4000,
  "restrictDepartmentId": 1000,
  "restrictClassId": 2000,
  "restrictSubclassId": 3000,
  "requestedDeliveryDate": "2025-02-10T15:26:28.424Z",
  "approvedDate": "2025-02-10T15:26:28.424Z",
  "lineItems": [
    {
      "itemId": "55001234",
      "quantity": 5,
      "caseSize": 2,
      "deliverySlotId": 5
    }
  ]
}

Schema — StoreOrderRequestExtIdo

Table 6-49 StoreOrderRequestItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
orderId	NA	number($int15) example: 222345666	The internal system identifier of the store order.
storeId	NA	number($int10) example: 5000	The identifier of the store that will receive the goods.
restrictSupplierId	NA	number($int12) example: 7000	Items requested should be restricted to this supplier.
restrictWarehouseId	NA	number($int12) example: 4000	Items requested should be restricted to this warehouse.
restrictDepartmentId	NA	number($int12) example: 1000	Items requested should be restricted to this department.
restrictClassId	NA	number($int12) example: 2000	Items requested should be restricted to this class.
restrictSubclassId	NA	number($int12) example: 3000	Items requested should be restricted to this subclass.
requestedDeliveryDate	NA	string($date-time)	The date the goods should be delivered.
approvedDate	NA	string($date-time)	The date the request for goods was approved by the store.
lineItems	NA	object	A collection of line items on the store order.

Table 6-50 StoreOrderRequestItemExtIdo— Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
quantity	NA	number($decimal(20,4)) example: 5	The quantity requested for delivery.
caseSize	NA	number($decimal(10,4)) example: 2	The case size requested for delivery.
deliverySlotId	NA	number($int15) example: 5	The identifier of the delivery time slot requested for the delivery of the item.

Responses

This section describes the responses of the Request Order API.

Response Code: 204

No content

Integration for Ticket Printing

When printing tickets, EICS sends ticket information to an external system for printing. This web service needs to be implemented for printing tickets to a physical printer. In the JET administration screen for configuration external service, this endpoint can be configured to connect to either a SOAP or a REST service implementation.

REST Service: Ticket Printing

The service is an external ticket printing integration service definition. It defines an end an endpoint that can be developed by a third party in order which allows EICS to send item ticket printing information to that end point, which then handles the physical ticket printing. The endpoint inputs and outputs must be ahdered to by the provider.

Publish Ticket

EICS will publish ticket information to print to this service.

Method

POST

URL

Request Parameters

There are no request parameters.

The request body is application/json.

Example Value

{
  "storeId": 5000,
  "printerName": "ABX100",
  "printerAddress": "http:/printers/ABX100",
  "printerId": "555",
  "formatType": 1,
  "formatReference": "Small Label",
  "templateId": 5433700,
  "tickets": [
    {
      "ticketId": 11111,
      "itemId": "7890",
      "primaryUpc": "78901",
      "originType": 1,
      "sequenceNumber": 12,
      "ticketCount": 1,
      "printQuantity": 12,
      "shortDescription": "Short description",
      "longDescription": "Long description",
      "shortDescriptionLanguage": "Translated short description",
      "longDescriptionLanguage": "Translated long description",
      "diffType1": "DiffType1",
      "diffType2": "DiffType2",
      "diffType3": "DiffType3",
      "diffType4": "DiffType4",
      "diffDescription1": "Diff1",
      "diffDescription2": "Diff2",
      "diffDescription3": "Diff3",
      "diffDescription4": "Diff4",
      "departmentId": 1000,
      "departmentName": "Hats",
      "classId": 2000,
      "className": "Top Hats",
      "subclassId": 3000,
      "subclassName": "Felt Top Hats",
      "priceCurrency": "USD",
      "priceValue": 4.99,
      "priceType": 1,
      "priceUom": "LBS",
      "priceActiveDate": "2025-09-09T13:26:27.929Z",
      "priceExpireDate": "2025-09-09T13:26:27.929Z",
      "overridePriceCurrency": "USD",
      "overridePriceValue": 4.99,
      "previousPriceCurrency": "USD",
      "previousPriceValue": 3.99,
      "previousPriceType": 1,
      "lowestMonthlyPriceCurrency": "USD",
      "lowestMonthlyPriceValue": 4.99,
      "lowestMonthlyPriceType": 1,
      "multiUnitPriceCurrency": "USD",
      "multiUnitValue": 4.99,
      "multiUnitUom": "EA",
      "multiUnitQuantity": 3,
      "countryOfManufacturer": "US",
      "udas": [
        {
          "name": "Temperature",
          "value": "30"
        }
      ]
    }
  ]
}

Schema — TicketPrintRequestIdo

Table 6-51 TicketPrintRequestIdo— Object

Element Name	Required	Data Type/Example	Description
storeId	yes	number($int10) example: 5000	The identifier of the store.
printerName	yes	string($text200) example: ABX100	The name of the printer.
printerAddress	yes	string($text300) example: http:/printers/ABX100	The URI (or network address) of the printer.
printerId	NA	string($text5) example: 555	The identifier of the printer.
formatType	yes	integer($int4) example: 1	The type of the ticket format to print. Valid values are: 1 - Item Ticket 2 - Shelf Label Enum: [ 1, 2 ]
formatReference	NA	string($text255) example: Small Label	A reference to the format content to use.
templateId	NA	integer($int12) example: 5433700	The identifier of the template to use to print the tickets.
tickets	Yes	object	The tickets to print.

Table 6-52 TicketIdo - Object

Element Name	Required	Data Type/Example	Description
ticketId	yes	number($int12) example: 11111	The unique identifier of the ticket.
itemId	yes	string($text25) example: 7890	The unique identifier of the item.
primaryUpc	NA	string($text25) example: 78901	The primary Unit Product Code for the item.
originType	NA	integer($int4) example: 1	The origin type. Valid values are: 1 - External 2 - Price Change 3 - Foundation 4 - Manual 5 - Promotional Price Change 6 - Clearance Price Change 7 - Permanent Price Chanage 8 - Reset Price Chanage Enum: [ 1, 2, 3, 4, 5, 6, 7, 8 ]
sequenceNumber	NA	integer($int3) example: 12	The sequence number of a ticket within a ticket grouping.
ticketCount	NA	integer($int3) example: 1	The number of instances of this ticket to print.
printQuantity	NA	number($decimal(12,4)) example: 12	The quantity to be printed on the ticket.
shortDescription	NA	string($text255) example: Short description	The short description of the item.
longDescription	NA	string($text400) example: Long description	The long description of the item.
shortDescriptionLanguage	NA	string($text255) example: Translated short description	The short description of the item in the language of the store.
longDescriptionLanguage	NA	string($text400) example: Translated long description	The long description of the item in the language of the store.
diffType1	NA	string($text10) example: DiffType1	The description of the differentiator type for differentiator 1.
diffType2	NA	string($text10) example: DiffType2	The description of the differentiator type for differentiator 2.
diffType3	NA	string($text10) example: DiffType3	The description of the differentiator type for differentiator 3.
diffType4	NA	string($text10) example: DiffType4	The description of the differentiator type for differentiator 4.
diffDescription1	NA	string($text255) example: Diff1	The description of the differentiator 1 for the item.
diffDescription2	NA	string($text255) example: Diff2	The description of the differentiator 2 for the item.
diffDescription3	NA	string($text255) example: Diff3	The description of the differentiator 3 for the item.
diffDescription4	NA	string($text255) example: Diff4	The description of the differentiator 4 for the item.
departmentId	NA	integer($int12) example: 1000	The department identifier of the item.
departmentName	NA	string($text360) example: Hats	The department name of the item.
classId	NA	integer($int12) example: 2000	The class identifier of the item.
className	NA	string($text360) example: Top Hats	The class name of the item.
subclassId	NA	integer($int12) example: 3000	The subclass identifier of the item.
subclassName	NA	string($text360) example: Felt Top Hats	The subclass name of the item.
priceCurrency	NA	string($text3) example: USD	The currency code of the ticket price.
priceValue	NA	number($decimal(12,4)) example: 4.99	The amount of the ticket price.
priceType	NA	integer($int3) example: 1	The type of the ticket price. Valid values are: 1 - Permanent 2 - Promotional 3 - Clearance 4 - Clearance Reset Enum: [ 1, 2, 3, 4 ]
priceUom	NA	string($text4) example: LBS	The unit of measure of the price.
priceActiveDate	NA	string($date-time)	The date the ticket price became active.
priceExpireDate	NA	string($date-time)	The date the ticket price expires.
overridePriceCurrency	NA	string($text3) example: USD	The override price currency code.
overridePriceValue	NA	number($decimal(12,4)) example: 4.99	The override price amount.
previousPriceCurrency	NA	string($text3) example: USD	The currency code of the previous price.
previousPriceValue	NA	number($decimal(12,4)) example: 3.99	The amount of the previous price.
previousPriceType	NA	integer($int3) example: 1	The price type of the previous type. Valid values are: 1 - Permanent 2 - Promotional 3 - Clearance 4 - Clearance Reset Enum: [ 1, 2, 3, 4 ]
lowestMonthlyPriceCurrency	NA	string($text3) example: USD	The currency code of the lowest monthly price.
lowestMonthlyPriceValue	NA	number($decimal(12,4)) example: 4.99	The amount of the lowest monthly price.
lowestMonthlyPriceType	NA	integer($int3)	The price type of the lowest monthly price. Valid values are: 1 - Permanent 2 - Promotional 3 - Clearance 4 - Clearance Reset Enum: [ 1, 2, 3, 4 ]
multiUnitPriceCurrency	NA	string($text3) example: USD	The currency code of the ticket's multi-unit price.
multiUnitValue	NA	number($decimcal(12,4)) example: 4.99	The amount of the ticket's multi-unit price.
multiUnitUom	NA	string($text3) example: EA	The unit of measure of the ticket's multi-unit price.
multiUnitQuantity	NA	number($decimal(12,4)) example: 3	The multi-unit quanitty associated to the price.
countryOfManufacturer	NA	string($text3) example: US	The two-letter country code denoting the country of manufacture for the item.
udas	NA	object	udas

Table 6-53 TicketUdaIdo - Object

Element Name	Required	Data Type/Example	Description
name	NA	string($text128) example: Temperature	The name of the user defined attribute.
value	NA	string($text128) example: 30	The value of the user defined attribute

Responses

This section describes the responses of the Publish TicketAPI.

Response Code: 204

No content

Integration of Transfers

When changes occur to transfer documents, EICS publishes the updated transfer to an external service. This occurs when the transfer stock quantities are altered or the transfer status changes. The service must be configured on the external services administration screen.

REST Service: Transfer Status (External)

This service publishes out the information about changes to a transfer document to an external endpoint. This occurs when the transfer stock quantities are altered or the transfer status changes.

Status Update

When the transfer status or quantities are altered, this operation is called to notify an external system of the state of the transfer.

Method

POST

URL

/tsfstatus

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the transfer that was altered.

Example Value

{
  "transferId": 3413412,
  "externalTransferId": "3464435",
  "distroNumber": "3464435",
  "sourceType": 1,
  "sourceId": 5000,
  "destinationType": 1,
  "destinationId": 5100,
  "status": 1,
  "contextCode": "BAC",
  "contextValue": "Temporary Remodel",
  "unavailable": false,
  "customerOrderNumber": "83233434",
  "fulfillmentOrderNumber": "CAD",
  "requestDate": "2025-02-11T13:00:29.658Z",
  "approveDate": "2025-02-11T13:00:29.658Z",
  "items": [
    {
      "itemId": "55001234",
      "quantityRequested": 10,
      "quantityApproved": 10,
      "quantityShipping": 5,
      "quantityShipped": 5,
      "caseSize": 100
    }
  ]
}

Schema — TransferExtIdo

Table 6-54 TransferExtIdo — Object

Element Name	Required	Data Type/Example	Description
transferId	NA	number($int15) example: 3413412	The identifier of the transfer.
externalTransferId	NA	string($text128) example: 3464435	The external identifier of the transfer if it originated in an external system.
distroNumber	NA	string($text128) example: 3464435	The distro number of the transfer.
sourceType	NA	number($int2) example: 1	The location type of the source location shipping the goods. Valid values are: 1 - Store 2 - Warehouse 3 - Finisher Enum: [ 1, 2, 3 ]
sourceId	NA	number($int10) example: 5000	The identifier of the location shipping the goods.
destinationType	NA	number($int2) example: 1	The location type of the destination location receiving the goods. Valid values are: 1 - Store 2 - Warehouse 3 - Finisher Enum: [ 1, 2, 3 ]
destinationId	NA	number($int10) example: 5100	The identifier of the location receiving the goods.
status	NA	number($int2) example: 1	The current status of the transfer. Valid values are: 1 - New Request 2 - Requested 3 - Request In Progress 4 - Rejected 5 - Canceled Request 6 - Transfer In Progress 7 - Approved 8 - In Shipping 9 - Completed 10 - Cancelled Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]
contextCode	NA	string($text6) example: BAC	The context code of a context associated to the transfer.
contextValue	NA	string($text25) example: Temporary Remodel	A value associated with the context.
unavailable	NA	boolean example: false	True indicates a transfer for unavailable quantities, false indicates that transfer is for available quantities.
customerOrderNumber	NA	string($text128) example: 83233434	The customer order number of a customer order associated to the transfer.
fulfillmentOrderNumber	NA	string($text128) example: CAD	The fulfillment order number of a customer order associated to the transfer.
requestDate	NA	string($date-time)	The date when the transfer was requested.
approveDate	NA	string($date-time)	The date the transfer was approved.
items		object	A collection of line items within the container.

Table 6-55 TransferItemExtIdo — Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
quantityRequested	NA	number($decimal(20,4)) example: 10	The quantity that has been requested.
quantityApproved	NA	number($decimal(20,4)) example: 10	The quantity that has been approved.
quantityShipping	NA	number($decimal(20,4)) example: 5	The quantity picked and in shipping.
quantityShipped	NA	number($decimal(20,4)) example: 5	The quantity that has been shipped.
caseSize	NA	number($decimal(10,4)) example: 100	The case size of the item on this transfer.

Responses

This section describes the responses of the Status Update API.

Response Code: 204

No content.

Integration of Transfer Receipts

EICS publishes out a vendor delivery receipt (DCS receipt) to an external endpoint when the delivery is confirmed. The service must be configured on the external services administration screen.

REST Service: Transfer Delivery Receipt (External)

This service publishes out the information about a transfer delivery receipt to an external endpoint. This occurs when the transfer delivery receipt is confirmed.

Receipt Confirmed

When the transfer delivery receipt is confirmed, this information about the receipt is sent.

Method

POST

URL

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the transfer delivery receipt that was confirmed.

Example Value

{
  "storeId": 5000,
  "sourceType": 2,
  "sourceId": 7100,
  "receiptNumber": "A3DA",
  "containers": [
    {
      "cartonId": 55001234,
      "externalCartonId": "234342",
      "referenceCartonId": "6764747",
      "trackingNumber": "863413410",
      "receiptDate": "2026-02-24T13:38:08.438Z",
      "adjusted": false,
      "missing": false,
      "items": [
        {
          "itemId": "55001234",
          "quantityExpected": 10,
          "quantityReceived": 10,
          "quantityDamaged": 5,
          "caseSize": 100,
          "unavailable": true,
          "documentType": 2,
          "documentId": 55001234,
          "customerOrderNumber": "143523465425",
          "fulfillmentOrderNumber": "134314",
          "uins": [
            {
              "uin": "20343932434",
              "status": 1
            }
          ],
          "extendedAttributes": [
            {
              "generatedBarcode": "(01)12345678901234(15)20251105",
              "quantity": 22,
              "values": [
                {
                  "code": "15",
                  "externalCode": "15",
                  "valueDate": "2026-02-24T13:38:08.438Z",
                  "valueLong": 678334324,
                  "valueDecimal": 1488.99,
                  "valueText": "12365478943255"
                }
              ]
            }
          ]
        }
      ]
    }
  ]

Schema — TransferReceiptExtIdo

Table 6-56 TransferReceiptExtIdo — Object

Element Name	Required	Data Type/Example	Description
storeId	NA	number($int10) example: 5000	The identifier of the store receiving the goods.
sourceType	NA	number($int2) example: 2	The location type of the source location shipping the goods. Valid values are: Store Warehouse Finisher Enum: [ 1, 2, 3 ]
sourceId	NA	number($int10) example: 7100	The location identifier of the location shipping the goods.
receiptNumber	NA	number($int12) example: A3DA	The receipt number of the delivery.
containers	NA	object	A collection of containers on the delivery.

Table 6-57 TransferReceiptContainerExtIdo — Object

Element Name	Required	Data Type/Example	Description
cartonId	NA	number($int12) example: 55001234	The system internal container identifier.
externalCartonId	NA	string($text128) example: 234342	An external system carton identifier for reference.
referenceCartonId	NA	string($text128) example: 6764747	A reference identifier to an alternate container, such as a misdirected container.
trackingNumber	NA	string($text128) example: 863413410	The tracking number of the container.
receiptDate	NA	string($date-time)	The date the container was received.
adjusted	NA	boolean example: false	True if the carton is adjusted from a previous receipt, false if the container is first receipt.
missing	NA	boolean example: false	True if the carton is missing from the receipt, false if it is received.
items	NA	object	A collection of line items within the container.

Table 6-58 TransferReceiptItemExtIdo — Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 55001234	The SKU level item identifier.
quantityExpected	NA	number($decimal(20,4)) example: 10	The quantity originally expected to be received.
quantityReceived	NA	number($decimal(20,4)) example: 10	The quantity received (as not damaged) for the item in this container.
quantityDamaged	NA	number($decimal(20,4)) example: 5	The quantity received as damage for the item in this container.
caseSize	NA	number($decimal(10,4)) example: 100	The case size of the item on this receipt.
unavailable	NA	boolean example: true	True if the quantities were received as unavailable, false if they were received as available. Note that even if this value is true, damaged quantities will still be received as unavailable.
documentType	NA	number($int2) example: 2	The type of document this item is associated to. Valid values are: 1 - Allocation 2 - Transfer Enum: [ 1, 2
documentId	NA	number($int15) example: 55001234	The identifier of the document associated to this item on the delivery.
customerOrderNumber	NA	string($text128) example: 143523465425	The customer order number if associated to a customer order.
fulfillmentOrderNumber	NA	string($text128) example: 134314	The fulfillment order number if associated to a customer order.
unis	NA	object	A collection of uins within the item.
extendedAttributes	NA	array(ExtendedAttributeExtIdo)	A collection of extended attributes attached to the line item. This must be the entire set of extended attributes to associate to the line item.

Table 6-59 UinExtIdo— Object

Element Name

Required

Data Type/Example

uin

NA

string($text128) example: 20343932434

The universal identifier number.

status

NA

number($int2) example: 1

The status of the UIN. Valid values are:

1 - In Stock

2 - Sold

3 - Shipped To Warehouse

4 - Shipped To Store

5 - Reserved For Shipping

6 - Shipped To Vender

7 - Removed From Inventory

8 - Unavailable

9 - Missing

10 - In Receiving

11 - Customer Order Reserved

12 - Customer Order Fulfilled

13 - shipped To Finisher

99 - Unconfirmed

Enum: [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 99 ]

For more information about the ExtendedAttributeExtIdo object, see the ExtendedAttributeExtIdo - Object section.

For more information about the ExtendedAttributeExtIdo object, see the ExtendedAttributeValueExtIdo - Object section.

Responses

This section describes the responses of the Receipt Confirmed API.

Response Code: 204

No content.

Integration of Order Available Stock On Hand

REST Service: Customer Order Store Available Inventory (External)

This service sends changes to the available inventory of items for stores that have been marked as customer order allowable stores. A system configuration flag for publishing customer order store available inventory must be enabled and the endpoint must be configured within the system. These messages are gathered and published asynchronously via MPS queue with the DpsInvAdjustment family, which must be enabled as well.

Available Inventory Update

The current available inventory positions are sent to this service whenever the item available inventory changes for an item at the store.

Method

POST

URL

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the location and items and their current available quantities.

Example Value

{
  "storeId": 5000,
  "items": [
    {
      "itemId": "76544400",
      "availableQuantity": 10
    }
  ]
}

Schema — CoAvailableInventoryIdo

Table 6-60 CoAvailableInventoryIdo — Object

Element Name	Required	Data Type/Example	Description
storeId	NA	number($int10) example: 5000	The identifier of the store receiving the goods.
items	NA	object	Items

Table 6-61 CoAvailableInventoryItemIdo— Object

Element Name	Required	Data Type/Example	Description
itemId	NA	string($text25) example: 76544400	The identifier of the item being updated.
availableQuantity	NA	number($decimal(20,4)) example: 10	The available quantity of the item at this store.

Responses

This section describes the responses of the Receipt Confirmed API.

Response Code: 204

No content.

Integration of Workflow Validation

SIOCS supports external integration for validation of certain workflow actions in the client application. EICS will call the external system to perform validation when a client application performs a workflow action that has an active configuration. The External Workflow Validation Administration screen is used to configure the actions. The External Services Administration screen is also required to have configured this external service.

REST Service: Workflow Validation (External)

This service provides external workflow validation endpoints for inventory adjustments, transfers, transfer deliveries, transfer shipments, vendor deliveries, and vendor shipments.

Inventory Adjustment Confirm

This section describes the Inventory Adjustment Confirm API. This operation will be called for validation of the inventory adjustment confirm workflow action.

Method

POST

URL

/invadjustments/confirm

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the inventory adjustment that is being confirmed.

Schema - InventoryAdjustmentIdo

See the API in the REST Service: InventoryAdjustment for details of the InventoryAdjustmentIdo data structure.

Responses

This section describes the responses of the Inventory Adjustment Confirm API.

Response Code: 200

Validation Operation Completed.

The media type is application/json.

Example Value

[
  {
    "success": true,
    "errorMessage": "This action was not allowed.",
    "infoMessage": "This action was allowed with additional information."
  }
]

Schema - ExternalWorkflowValidationResult

Table 6-62 ExternalWorkflowValidationResult - Object

Element Name	Required	Data Type/Example	Description
success	Yes	boolean example: true	True if the action is valid, otherwise false.
errorMessage	No	string($text2000) example: This action was not allowed.	An error message to be displayed to the user for a validation failure.
infoMessage	No	string($text2000) example: This action was allowed with additional information.	An optional informational message to be displayed to the user for successful validation.

Transfer Approve

This section describes the Transfer Approve API. This operation will be called for validation of the transfer that is being approved.

Method

POST

URL

/transfers/approve

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the transfer that is being approved.

Schema - TransferIdo

See the API in the REST Service: Transfer for details of the TransferIdo data structure.

Responses

This section describes the responses of the Transfer Approve API.

For details about responses, see Response Code: 200.

Transfer Request

This section describes the Transfer Request API. This operation will be called for validation of the transfer that is being requested.

Method

POST

URL

/transfers/request

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the transfer that is being requested.

Schema - TransferIdo

See the API in the REST Service: Transfer for details of the TransferIdo data structure.

Responses

This section describes the responses of the Transfer Request API.

For details about responses, see Response Code: 200.

Transfer Delivery Confirm

This section describes the Transfer Delivery Confirm API. This operation will be called for validation of the transfer delivery that is being confirmed.

Method

POST

URL

/tsfdeliveries/confirm

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the transfer delivery that is being confirmed.

Schema - TransferDeliveryIdo

See the API in the REST Service: Transfer Delivery for details of the TransferDeliveryIdo data structure.

Responses

This section describes the responses of the Transfer Delivery Confirm API.

For details about responses, see Response Code: 200.

Transfer Delivery Receive

This section describes the Transfer Delivery Receive API. This operation will be called for validation of the transfer delivery that is being received. Its quantities are being set but the delivery is not yet confirmed.

Method

POST

URL

/tsfdeliveries/receive

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the transfer delivery that is being received.

Schema - TransferDeliveryIdo

See the API in the REST Service: Transfer Delivery for details of the TransferDeliveryIdo data structure.

Responses

This section describes the responses of the Transfer Delivery Receive API.

For details about responses, see Response Code: 200.

Transfer Delivery Carton Confirm

This section describes the Transfer Delivery Carton Confirm API. This operation will be called for validation of the transfer delivery carton that is being confirmed.

Method

POST

URL

/tsfdeliveries/cartons/confirm

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the transfer delivery carton that is being confirmed. The transfer delivery is sent along with only the carton information of the carton being confirmed.

Schema - TransferDeliveryIdo

See the API in the REST Service: Transfer Delivery for details of the TransferDeliveryIdo data structure.

Responses

This section describes the responses of the Transfer Delivery Carton Confirm API.

For details about responses, see Response Code: 200.

Transfer Shipment Submit

This section describes the Transfer Shipment Submit API. This operation will be called for validation of the transfer shipment that is being submitted.

Method

POST

URL

/tsfshipments/submit

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the transfer delivery that is being submitted.

Schema - TransferShipmentIdo

See the API in the REST Service: Transfer Shipment for details of the TransferShipmentIdo data structure.

Responses

This section describes the responses of the Transfer Shipment Submit API.

For details about responses, see Response Code: 200.

Transfer Shipment Dispatch

This section describes the Transfer Shipment Dispatch API. This operation will be called for validation of the transfer shipment that is being dispatched.

Method

POST

URL

/tsfshipments/dispatch

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the transfer shipment that is being dispatched.

Schema - TransferShipmentIdo

See the API in the REST Service: Transfer Shipment for details of the TransferShipmentIdo data structure.

Responses

This section describes the responses of the Transfer Shipment Dispatch API.

For details about responses, see Response Code: 200.

Transfer Shipment Carton Confirm

This section describes the Transfer Shipment Carton Confirm API. This operation will be called for validation of the transfer shipment carton that is being confirmed.

Method

POST

URL

/tsfshipments/cartons/confirm

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the transfer shipment carton that is being confirmed. The transfer shipment is sent along with only the carton information of the carton being confirmed.

Schema - TransferShipmentIdo

See the API in the REST Service: Transfer Shipment for details of the TransferShipmentIdo data structure.

Responses

This section describes the responses of the Transfer Shipment Carton Confirm API.

For details about responses, see Response Code: 200.

Vendor Delivery Confirm

This section describes the Vendor Delivery Confirm API. This operation will be called for validation of the vendor delivery that is being confirmed.

Method

POST

URL

/dsds/confirm

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the vendor delivery that is being confirmed.

Schema — VendorDeliveryIdo

Table 6-63 VendorDeliveryIdo— Object

Element Name	Required	Data Type/Example	Description
deliveryId	NA	number($int12) example: 11111	The unique identifier of the vendor delivery.
storeId	NA	number($int10) example: 5000	The identifier of the store receiving the inventory.
supplierId	NA	number($int10) example: 5101	The identifier of the supplier shipping the inventory.
status	NA	integer($int4) example: 1	The current status of the vendor delivery. Valid values are: 1 - New 2 - In Progress 3 - Received 4 - Canceled 5 - Rejected Enum: [ 1, 2, 3, 4, 5 ]
originType	NA	integer($int4) example: 1	The origin type of the vendor delivery. Valid values are: 1 - Advanced Shipping Notification 2 - Purchase Order 3 - DEX-NEX 4 - Manual/On The Fly Enum: [ 1, 2, 3, 4 ]
purchaseOrderId	NA	number($int12) example: 789012	The purchase order that the delivery is associated to (at header level).
receiptNumber	NA	integer($int12) example: 90000	The global receipt number of the delivery, used to identify the receipt across applications through integration.
asn	NA	string($text128) example: 784562	The advanced shipping notification.
invoiceNumber	NA	string($text128) example: 10056	The unique identifier of the invoice associated to the delivery.
invoiceCurrency	NA	string($text3) example: USD	The currency code of the invoice cost.
invoiceAmount	NA	number($decimal(12,4)) example: 999.99	The value of the invoice cost.
customerOrderId	NA	string($text128) example: 45000	The identifier of a customer order associated to the delivery.
fulfillmentOrderId	NA	string($text128) example: 45001	The identifier of a fulfillment order associated to the delivery.
displayCartonInfo	NA	boolean example: true	True if carton information should be displayed in the UI, false otherwise.
billOfLadingId	NA	string($text128) example: 55601	An external identifier of a bill of lading record.
carrierName	NA	string($text128) example: Speedy Delivery	The name of the carrier.
carrierCode	NA	string($text4) example: SPDE	A unique code that identifies the carrier.
countryCode	NA	string($text3) example: US	A country code of the country of the bill of lading.
sourceAddress	NA	string($text1000) example: 200 Apple Street, Coolsville, WI, 55555	The address of the source shipping location sending the delivery.
licensePlate	NA	string($text128) example: ABC-123	The license plate of the delivery vehicle.
freightId	NA	string($text128) example: 882211	A freight identifier associated to the delivery.
fiscalDocumentRequestId	NA	number($int20) example: 22233344455566	The identifier of the request for a fiscal document.
fiscalDocumentReferenceId	NA	number($int20) example: 77788899100	The unique identifier of the fiscal document record.
fiscalDocumentNumber	NA	string($text255) example: 128745	The fiscal document number.
createDate	NA	string($date-time)	The date the delivery was created.
updateDate	NA	string($date-time)	The date the delivery was last updated.
expectedDate	NA	string($date-time)	The expected delivery date of the delivery.
invoiceDate	NA	string($date-time)	The date of the delivery invoice.
receivedDate	NA	string($date-time)	The date the delivery was received.
createUser	NA	string($text128) example: smith123	The user that created the delivery record.
updateUser	NA	string($text128) example: smith123	The user that last updated the delivery record.
receivedUser	NA	string($text128) example: smith123	The user that received the delivery record.
customAttributes	NA	object	A collection of customer attributes associated to the delivery.
cartons	NA	object	The containers belonging to this delivery.

For more information about the CustomAttributeIdo object, see the CustomAttributeIdo - Object section.

Table 6-64 VendorDeliveryCartonIdo— Object

Element Name	Required	Data Type/Example	Description
cartonId	NA	integer($int12) example: 100200300	The unique identifier of the carton record.
externalCartonId	NA	string($text128) example: 444200301	The external identifier of the carton.
referenceId	NA	string($text128) example: 200440012	A reference identifier for the carton.
status	NA	integer($int4) example: 1	The current status of the carton. Valid values are: 1 - New 2 - In Progress 3 - Submitted 4 - Received 5- Damaged 6 - Missing 7 - Canceled Enum: [ 1, 2, 3, 4, 5, 6, 7 ]
damageReason	NA	string($text128) example: Dropped	A reason for the carton damage that took place.
serialCode	NA	number($int18) example: 337654	A serial code for the carton.
trackingNumber	NA	string($text128) example: AZB12743D	A tracking number for the carton.
damageRemaining	NA	boolean example: false	True indicates all remaining quantities should be marked damaged on final receipt.
uinRequired	NA	boolean example: false	True if a UIN item exists within the carton, false otherwise.
receiveAtShopFloor	NA	boolean example: false	True if delivery should receive inventory to the shop floor, false otherwise.
qualityControl	NA	boolean example: false	True indicates the carton requires detailed receiving.
externalCreate	NA	boolean example: false	True indicates the carton was externally created, false indicates it was created by EICS.
adjusted	NA	boolean example: false	True indicates the carton has been adjusted.
customerOrderRelated	NA	integer($int4) example: 1	Defines whether or not the items within the carton are related to customer orders. Valid values are: 1 - Yes 2 - Mix 3 - No Enum: [ 1, 2, 3 ]
createDate	NA	string($date-time)	The date the carton was created.
updateDate	NA	string($date-time)	The date the carton was last updated.
receivedDate	NA	string($date-time)	The date the carton was received.
createUser	NA	string($text128) example: smith123	The user that created the carton record.
updateUser	NA	string($text128) example: smith123	The user that last updated the carton record.
receivedUser	NA	string($text128) example: smith123	The user that received the carton record.
customAttributes	NA	object	A collection of customer attributes associated to the delivery carton.
lineItems	NA	object	The items belonging to the carton.

Table 6-65 VendorDeliveryLineItemIdo— Object

Element Name	Required	Data Type/Example	Description
lineId	NA	integer($int12) example: 2222222	The unique identier of the line item record.
itemId	NA	string($text25) example: 10045600	The unique identifier of the SKU item.
caseSize	NA	number($decimal(10,2)) example: 10	A case size of the item in this container.
quantityExpected	NA	number($decimal(20,4)) example: 5	The total amount expected on the delivery.
quantityReceived	NA	number($decimal(20,4)) example: 3	The total amount received on the delivery.
quantityDamaged	NA	number($decimal(20,4)) example: 2	The total amount received as damaged on the delivery.
quantityReceivedOverage	NA	number($decimal(20,4)) example: 3	Amount of received inventory over expected quantities.
quantityDamagedOverage	NA	number($decimal(20,4)) example: 2	Amount of received as damaged inventory over expected quantities.
quantityPreviouslyReceived	NA	number($decimal(20,4)) example: 3	Units previously received (captured at time container is re-opened after receipt).
quantityPreviouslyDamaged	NA	number($decimal(20,4)) example: 2	Units previously received as damaged (captured at time container is re-opened after receipt).
unitCostCurrency	NA	string($text3) example: USD	The currency of the unit cost of this delivery.
unitCostAmount	NA	number($decimal(20,4)) example: 14.5	The unit cost value of this delivery.
unitCostOverrideCurrency	NA	string($text3) example: USD	The currency of the override unit cost of this delivery.
unitCostOverrideAmount	NA	number($decimal(20,4)) example: 17.5	The override unit cost value of this delivery.
purchaseOrderId	NA	integer($int12) example: 500678	The unique identifier of the purchase order for this item.
purchaseOrderNumber	NA	string($text128) example: DX4600	The external purchase order number for this item.
customerOrderNumber	NA	string($text128) example: CO100000	The unique external customer order identifier this item is fulfilling.
fulfillmentOrderNumber	NA	string($text3) example: FO12	The unique external fulfillment order identifier this item is fulfilling.
vendorProductNumber	NA	string($text256) example: 147800	The vendor product number of the item.
uins	NA	object	The UINs being received as part of this item.
extendedAttributes	NA	object	A collection of extended attributes attached to the line item.

Table 6-66 VendorDeliveryLineItemUinIdo— Object

uin	NA	string($text128) example: 14532B12	The Universal Identification Number.
shipped	NA	Boolean example: true	True if the UIN was shipped from the supplier as part of the delivery, false otherwise.
received	NA	boolean example: true	True if the UIN is received as part of the delivery, false otherwise.
damaged	NA	boolean example: false	True if the UIN is received as damaged as part of the delivery, false otherwise.

For more information about the ExtendedAttributeIdo object, see the ExtendedAttributeIdo - Object section.

For more information about the ExtendedAttributeValueIdo object, see the ExtendedAttributeValueIdo - Object section.

Responses

This section describes the responses of the Vendor Delivery Confirm API.

For details about responses, see Response Code: 200.

Vendor Delivery Receive

This section describes the Vendor Delivery Receive API. This operation will be called for validation of the vendor delivery that is being received. Its quantities are being set but the delivery is not yet confirmed.

Method

POST

URL

/dsds/receive

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the vendor delivery that is being received.

Schema - VendorDeliveryIdo

See the API in the REST Service: Vendor Delivery for details of the VendorDeliveryIdo data structure.

Responses

This section describes the responses of the Vendor Delivery Receive API.

For details about responses, see Response Code: 200.

Vendor Delivery Carton Confirm

This section describes the Vendor Delivery Carton Confirm API. This operation will be called for validation of the vendor delivery carton that is being confirmed.

Method

POST

URL

/dsds/cartons/confirm

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the vendor delivery carton that is being confirmed. The vendor delivery is sent along with only the carton information of the carton being confirmed.

Schema - VendorDeliveryIdo

See the API in the REST Service: Vendor Delivery for details of the VendorDeliveryIdo data structure.

Responses

This section describes the responses of the Vendor Delivery Carton Confirm API.

For details about responses, see Response Code: 200.

Vendor Shipment Submit

This section describes the Vendor Shipment Submit API. This operation will be called for validation of the vendor shipment that is being submitted.

Method

POST

URL

/rtvshipments/submit

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the vendor shipment that is being submitted.

Schema - VendorShipmentIdo

See the API in REST Service: Vendor Shipment for details of theVendorShipmentIdo data structure.

Responses

This section describes the responses of the Vendor Shipment Submit API.

For details about responses, see Response Code: 200.

Vendor Shipment Dispatch

This section describes the Vendor Shipment Dispatch API. This operation will be called for validation of the vendor shipment that is being dispatched.

Method

POST

URL

/rtvshipments/dispatch

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the vendor shipment that is being dispatched.

Schema - VendorShipmentIdo

See the API in REST Service: Vendor Shipment for details of theVendorShipmentIdo data structure.

Responses

This section describes the responses of the Vendor Shipment Dispatch API.

For details about responses, see Response Code: 200.

Vendor Shipment Carton Confirm

This section describes the Vendor Shipment Carton Confirm API. This operation will be called for validation of the vendor shipment carton that is being confirmed.

Method

POST

URL

/rtvshipments/cartons/confirm

Request Parameters

There are no request parameters.

The request body is application/json.

Details about the vendor shipment carton that is being confirmed. The vendor shipment is sent along with only the carton information of the carton being confirmed.

Schema - VendorShipmentIdo

See the API in REST Service: Vendor Shipment for details of theVendorShipmentIdo data structure.

Responses

This section describes the responses of the Vendor Shipment Carton Confirm API.

For details about responses, see Response Code: 200.

Common Objects

CustomAttributeExtIdo - Object

Table 6-67 CustomAttributeExtIdo - Object

Element Name	Required	Data Type/Example	Description
adminId	Yes	integer($int12) example: 83927	The custom attribute administration identifier.
publishCode	No	string($text80) example: AXS	The holds a publish code that identifies the nature or context of the custom attributes. This is configured when setting up the custom attributes.
dataType	Yes	integer($int4) example: 1	The type of data this customer is. Value values are 1 - Long; 2 - Decimal; 3 - Text; 4 - Date; 5 - Drop Down.
dateValue	No	string($date-time)	The value of the custom attribute if it is a date.
longValue	No	integer($int20) example: 18374108	The value of the custom attribute if it is a non-decimal number.
decimalValue	No	number($decimal(30,9)) example: 100.12	The value of the custom attribute if it is a decimal number.
textValue	No	string($text128) example: Yellow	The value of the custom attribute if it is text.
dropDownCode	No	string($text6) example: SKA	This holds a unique publish code of a drop down selection if the data type is drop down.

ExtendedAttributeExtIdo - Object

Table 6-68 ExtendedAttributeExtIdo - Object

Element Name	Required	Data Type/Example	Description
generatedBarcode	Yes	string($text128) example: (01)12345678901234(15)20251105	A generated barcode representing the values captured as part of this extended attribute.
inventoryCode	NA	string($text128) example: (01)12345678901234(10)44444(15)20251105	A barcode representing a unique generated code that inventory can be stored against. This is a GS1 encoded representation of the item and trackable attribute values. For example, tracking inventory positions for lot or batch number along with best buy date. This can differ from the overall barcode because it only captures trackable attributes whereas a full barcode might contain multiple other untracked attributes.
quantity	Yes	number($decimal(20,4)) example: 22	The quantity of this specific extended attribute capture.
values	Yes	array(ExtendedAttributeValueExtIdo)	A collection of value pairs attached to the line item.

ExtendedAttributeValueExtIdo - Object

Table 6-69 ExtendedAttributeValueExtIdo — Object

Element Name	Required	Data Type/Example	Description
gs1Code	NA	string($text4) example: 15	The GS1 international standardized AI code defining the data. Only the data type defined by this AI code should be captured; the other value fields should be left blank. For example, AI code 15 is Best Buy Date, so only the `valueDate` attribute should be populated. If an AI code is provided, a corresponding value must also be provided.
externalCode	NA	string($text80) example: 15	An external code representing the type of data being sent. The external code is configured within administration screens as an external representation of the AI code. For example, for Lot/Batch (AI code 10), this value might be `LOT`.
valueDate	NA	string($date-time)	A date value representing the captured data for the GS1 AI code.
valueLong	NA	number($int20) example: 678334324	A long value representing the captured data for the GS1 AI code.
valueDecimal	NA	number($decimal30,9) example: 1488.99	A decimal value representing the captured data for the GS1 AI code.
valueText	NA	string($text128) example: 12365478943255	A text value representing the captured data for the GS1 AI code.

6 Outbound Integration

Managing External Publication

Integration with Customer Order System

REST Service: Fulfillment Order Address (External)

Order Address

Method

URL

Request Parameters

Example Value

Schema — FulfillmentOrderAddressCriticalExtIdo

Responses

Response Code: 200

Example Value

Schema — FulfillmentOrderAddressExtIdo

REST Service: Customer Fulfillment Order Status (External)

Order Query

Method

URL

Request Parameters

Example Value

Schema — FulfillmentOrderCriteriaIdo

Responses

Response Code: 200

Example Value

Schema — FulfillmentOrderExtIdo

Order Accepted

Method

URL

Request Parameters

Example Value

Schema — FulfillmentOrderAcceptExtIdo

Responses

Response Code: 204

Order Rejected

Method

URL

Request Parameters

Example Value

Schema — FulfillmentOrderRejectIdo

Responses

Response Code: 204

Order Status

Method

URL

Request Parameters

Example Value

Schema — FulfillmentOrderStatusExtIdo

Responses

Response Code: 204

Integration of Direct From Vendor Receipts

REST Service: Vendor Delivery Receipt (External)

Receipt Confirmed

Method

URL

Request Parameters

Example Value

Schema — VendorDeliveryReceiptExtIdo

Responses

Response Code: 204

Integration of Direct From Vendor Return

REST Service: Vendor Return (External)

Update Return

Method

URL

Request Parameters

Example Value

Schema — VendorReturnExtIdo

Responses

Response Code: 204

Integration of Fiscal Documents

REST Service: Fiscal Document (External)

Document Requested

Method

URL

Request Parameters

Example Value

Schema - FiscalDocumentRequestExtIdo

Responses

Response Code: 204

Document Canceled