API default settings exist for each user & endpoint. These settings if passed within a API call can override the default value for that call only. Please try overriding such settings by simply passing the setting within the call
Export Function: This is where we determine the export format. e.g., json, xml, or csv to the export function.
- export.json
- export.xml
- export.csv
example: https://staging-portalapp.springsystems.com/api/po-outgoing/export.json/po.filter.gt.po_id/305357
This bypasses the default XML return format.
By default, when submitting a transaction to PortalApp (I.e. send_invoice), the system is configured so it does NOT trigger an outgoing transmission to the retailer, it simply creates the invoice. This default operation can be overridden by your setup technician or case by case by providing this setting override.
- send_outgoing_transaction_after/1
- ?send_outgoing_transaction_after=1 (1 = yes, 0=no)
This controls whether a subsequent transaction is triggered to be sent, e.g. if you create an invoice or shipment, do you want to send it to the retailer. If you want it to be sent, you can override the default by appending:
example: https://staging-portal.springsystems.com/api/ship-incoming/send?send_outgoing_transaction_after=1
This bypasses the API user’s default setting and ensures that as the transaction is created in PortalApp, it is also sent outbound to the recipient, e.g. shipment/ASN/invoice is transmitted to the retailer, or ship request/940 sent to the warehouse, etc. Alternatively when troubleshooting, it can be helpful to turn off 'send_outgoing_transaction_after' (set to 0 / do not send) as this would allow a transaction to be created in PortalApp but avoid validation errors that can be triggered during outbound process.
Examples of other adjustable settings include:
- pagination.limit/
- ?pagination.limit=50