Version: eXtendPS-SE 1.5.0 and above
Audience: Administrator

Overview

eXtendPS-SE now supports PromoStandards Order Shipment Notification (OSN) 2.0.0 via the getOrderShipmentNotification method. This version introduces structured shipment responses, multiple query types, configurable field mappings for customer pickup and pre-production proof, and improved error handling via ServiceMessageArray.

This article describes how to enable and configure the OSN 2.0.0 service in your NetSuite account.

For advanced use-cases of mapping statuses, please contact support@extendtech.net.

Prerequisites

  • Important: The Shipping Items: View permission is required on your integration user's role.
    • This permission has been added automatically to the eXtendPS-SE Server User and eXtendPS-SE Configuration Role [BUNDLE] roles.
    • If you use a custom role for your integration user, add this permission manually under Lists → Shipping Items → View.

Enable the Service

  1. Navigate to eXtendTech → eXtendPS-SE → eXtendPS-SE Setup.
  2. In the Services field, enable shipment 2.0.0.
  3. Click Submit to save your changes.

Once enabled, the Shipment 2.0.0 endpoint URL will be visible on the eXtendPS-SE SOAP Services screen. View Endpoint URLs in eXtendPS-SE.

Note: You can keep both OSN 1.0.0 and OSN 2.0.0 active simultaneously. eXtendTech recommends against disabling OSN 1.0.0 until all your connected customers/distributors have migrated to the new version.

Grant User Access

  1. Navigate to eXtendTech → eXtendPS-SE → eXtendPS-SE Users.
  2. Open the customer/distributor's eXtendPS-SE Users record.
  3. In the eXtendPS-SE Services field, enable Shipment 2.0.0.
  4. Click Submit.
Image Placeholder

See eXtendPS-SE – Add/Remove User for more information on working with eXtendPS-SE Users records.

Note: If a distributor attempts to query OSN 2.0.0 without access enabled on their eXtendPS-SE User record, the service returns an authentication fault ("Customer is not configured for accessing order shipment notification api").

Service Configuration

To configure the OSN 2.0.0 service, go to eXtendTech → eXtendPS-SE → Order Shipment Notification Setup and edit the Order Shipment Notification 2.0 settings.

Image Placeholder

Configure WSDL Mappings

Configure Order Shipment Notification Settings

Field
Description
Customer Pickup (custrecord_extend_promo_customer_pickup)
A multi-select field to designate which shipping methods represent a customer pickup. When the shipment's ship method matches one of the selected values, the customerPickup element in the response returns true.
Pre-Production Proof (custrecord_extend_promo_pre_production_p)
A field mapping to a body-level field on the Item Fulfillment record. Its value is returned in the preProductionProof element of the response. Valid PromoStandards return values are Yes, No, or Unknown. If no field is mapped or the field is empty, Unknown is returned.

Ship Method (Carrier/Service) Mapping

If the Ship Method field is configured on the Order Shipment Notification Setup, the service performs an additional join on the Shipping Item record to resolve the carrier and service values for the <FreightDetails> element in the response.

  • carrier — Resolved from the shipping item's carrier category.
  • service — Resolved from the shipping item's display name/text value.
Image Placeholder

Note: Ensure that your Item Fulfillment records have a valid ship method selected. If no ship method is present, the <FreightDetails> element returns a dash (-) for carrier and service.

Handling Incomplete Data

If a shipment record is missing required address information (e.g., ship-from or ship-to address fields are empty), the service skips that specific record and continues returning the remaining valid shipment records in the response. An error is not thrown for individual incomplete records.

Validate the Service Response

After configuration is complete, validate the OSN 2.0.0 response using SoapUI or similar tool to confirm field mappings and response structure conform to the PromoStandards specification. See Validating PromoStandards Services using SoapUI for instructions.

Next Steps

  1. Add endpoint to PromoStandards.org — See View Endpoint URLs in eXtendPS-SE for instructions on locating your new OSN 2.0.0 endpoint URL. Add this URL to your service listings on PromoStandards.org.
  2. Notify customers/distributors — Communicate the new version's availability and provide the new endpoint URL so distributors can upgrade at their convenience.

Frequently Asked Questions (FAQs)

Q: How do we handle multiple tracking numbers on a single Item Fulfillment?
A: Under Order Shipment Notification Setup → Additional Configuration, enable Package for each Tracking number. This creates distinct package objects for each tracking number on the fulfillment.