Transmit an ASN or PO

This JSON endpoint enables you to transmit a single Advance Shipping Notice (ASN) or Purchase Order (PO) to Radial systems.

  • ASN: An Advanced Shipping Notification includes carton-level details, allowing Radial to simply scan the carton ID barcodes during the inbound process.

  • PO: A Purchase Order indicates the items and quantities included on an inbound shipment but does not provide carton-level details. In this case, Radial must enter the carton quantities manually.

Details

Resource
  POST /sellers/{sellerId}/poasn/create
Sample Request URL
curl -L -X POST 'https://tst04-epapi-na.gsipartners.com/poasn-manager-service/sellers/TMSNA/poasn/create' \

Examples and Field Definitions

Copy 
curl -L -X POST 'https://tst04-epapi-na.gsipartners.com/poasn-manager-service/sellers/TMSNA/poasn/create' \
-H 'Content-Type: application/xml' \
-H 'apiKey: ************************************' \

-d '{
    "poData": [
        {
            "header": {
                "storeCode": "988",
                "receivingType": "P",
                "shipmentNumber": "IAJUS-116294",
                "orderDate": "2023-06-14",
                "shipmentReceiptDate": "2023-06-24",
                "shipperName": "Really Good Cookware",
                "receivingWarehouseId": "445",
                "headerExtendedAttributes": {
                    "extendedAttributes": {
                        "name": "",
                        "description": "",
                        "value": ""
                    }
                }
            },
            "details": {
                "detail": [
                    {
                        "clientItemId": "RITOCS005c",
                        "shippedQuantity": 2,
                        "itemCost": 0.99,
                        "shippingComments": "comment",
                        "trailerNumber": "125678",
                        "receivingWarehouseId": "445",
                        "detailExtendedAttributes": {
                            "extendedAttributes": [
                                {
                                    "name": "",
                                    "description": "",
                                    "value": ""
                                }
                            ]
                        }
                    }
                ]
            }
        }
    ]
}

  • HTTP Status 200: The receiving detail was created successfully.

    Copy 
    {
        "poAsnData": [
            {
                "poAsnNumber": "IAJUS-119194",
                "store_id": "967",
                "catalog_id": "21",
                "successfull_imported": "2",
                "total_errors_encountered": "0",
                "file_name": "cf2888dd-12c2-4ba3-a0aa-b538a76351d4",
                "client_id": "445",
                "reportedFrom": "ROM MMS",
                "errors": []
            }
        ]
    }

  • HTTP Status 400: The receiving detail creation failed.

    Copy 
    {
        "poAsnData": [
            {
                "status": "FAILED",
                "poAsnNumber": "",
                "successfull_imported": "0",
                "errors": [
                    {
                        "code": "FILE_VALIDATION_FAILED",
                        "message": "Invalid File/Contents. Missing Header Information",
                        "poAsnErrorPayload": {
                            "shippedQuantity": 0
                        },
                        "type": "HEADER_LEVEL_ERROR"
                    }
                ]
            }
        ]
    }
Field Name Parent Tag Data Type Length Required? Description
ReceivingDetail root Set N/A Required Encapsulates the ASN or PO and is the root element of the payload
Receiving Details
ASNData ReceivingDetail Set N/A Conditional Encapsulates the details of an ASN.Required if the order is being sent as an ASN.
POData ReceivingDetail Set N/A Conditional Encapsulates the details of a PO.Required if the order is being sent as a PO.
ASNData
Header ASNData Set N/A Required Encapsulates the order-level information of an ASN.
Details ASNData Set N/A Required Encapsulates the item-level details of an ASN.
POData
Header POData Set N/A Required Encapsulates the order-level information of a PO.
Details POData List N/A Required Encapsulates the item-level details of a PO.
Header
ASNNumber Header String 15 Conditional The ASN Number (for POs this is left blank).Required for ASNs.
HeaderExtendedAttributes Header List N/A Optional Encapsulates any order-level extended attributes, which are name/value pairs used for various needs.Radial will let you know if any are required based on your specific needs.
OrderDate Header Date   Optional The date the order was created by the Partner.The ISODate formats are "2023-12-15T10:00:00Z".
POStatus Header String      
ReceivingType Header String 1 Required  Indicates if the order is being transmitted as an ASN or PO. • "A" = ASN (includes carton-level details) • "P" = PO (does not include carton-level details)
ReceivingWarehouseId Header String   Required  A unique identifer, provided by Radial, indicating which Radial warehouse the order is coming to.
SellerId Header String      
ShipmentNumber Header String 15 Conditional The PO Number for PO's (for ASNs this is left blank).Required for POs.
ShipmentReceiptDate Header Date   Required  Date the shipment is expected to arrive at the Radial warehouse, which aids in warehouse inbound planning.The ISODate formats are "2023-12-15T10:00:00Z".
ShipperName Header String 30 Required  The name of the shipping entity, typically either the name of the Partner's warehouse or the name of the vendor.
StoreCode Header String 5 Required  
HeaderExtendedAttributes
ExtendedAttributes HeaderExtendedAttributes List N/A Optional Container for an order-level Extended Attribute, which is a name/value pair used to describe order attributes.Radial will provide values as needed.
ExtendedAttributes
Description ExtendedAttributes String   Optional Human-readable description of the Extended Attribute.
Name ExtendedAttributes String   Required Identifies the type of Extended Attribute.Radial will provide values as needed.
Value ExtendedAttributes String   Required The value associated to the Extended Attribute Name.
Details
Detail Details Set N/A Required Container for the Detail objects that provide item or carton-level information.
Detail
ASNNumber Detail String 15 Conditional The ASN Number (for POs this is left blank).Required for ASNs.
CartonId Detail String   Conditional The unique carton identifier which, when scanned, indicates the item and quantity within the carton.Required for ASNs.
ClientItemId Detail String 15 Required The retailer's unique item identifier.
DetailExtendedAttributes Detail List N/A Optional Encapsulates any detail-level extended attributes, which are name/value pairs used for various needs.Radial will let you know if any are required based on your specific needs.
ItemCost Detail Decimal 0 to 999999 Required The unit cost of the item.
LineNumber Detail String   Optional The line number for the item or specific carton, only necessary if you need it included in status updates from Radial.
ReceivingWarehouseId Detail String 99999 Required  A unique identifer, provided by Radial, indicating which Radial warehouse the order is coming to.
ShippedQuantity Detail Numeric 99999 Required Quantity, in units, shipped to the Radial Warehouse.
ShippingComments Detail String 100 Optional Miscellaneous comments about the shipment or items within the shipment.
TrailerNumber Detail String 25 Required Identifier for the trailer coming to the Radial Warehouse.
DetailExtendedAttributes
ExtendedAttributes DetailExtendedAttributes List N/A Optional Container for a detail-level Extended Attribute, which is a name/value pair used to describe item attributes.Radial will provide values as needed.