Admin Field Reference
Use this page when you need the literal Magento field or configuration path. For setup decisions and consequences, start with Configuration.
Buyer profile
| Field | Required or effect |
|---|---|
| Store | Required. Selects catalog, customer website and scoped PunchOut configuration. All Store Views creates a global fallback profile. |
| Buyer ID | Required external identity used to resolve the profile. |
| Protocol | Required: oci or cxml. Controls visible credentials and compatible mappings. |
| cXML Sender Domain | Required for cXML identity matching. |
| cXML Sender Identity | Required for cXML identity matching and normally the resolved buyer ID. |
| cXML Shared Secret | Required for a new cXML buyer; encrypted at rest. Use the Change switch to replace it later. |
| Accept PunchOutSetupRequest | Enables cXML setup for this buyer and advertises the transaction through Profile Discovery. |
| Accept OrderRequest | Enables inbound cXML orders for this buyer and advertises the transaction through Profile Discovery. |
| OCI Username | Required for OCI identity matching. |
| OCI Password | Required for a new OCI buyer; encrypted at rest. Use the Change switch to replace it later. |
| Customer Resolution Mode | Selects guest access, a fixed Magento customer, customer e-mail mapping, or optional/required request customer ID mapping. |
| Magento Customer | Required only for the fixed-customer mode. The selected account must belong to the buyer profile's website. |
| Identity Source | Selects the protocol field or cXML Extrinsic that supplies the customer e-mail or request customer ID. |
| JIT Provisioning | Inherits the Store-view setting or explicitly enables/disables customer creation when e-mail mapping finds no account. |
| JIT Customer Group | Customer group for accounts created through JIT provisioning. |
| OCI First/Last Name Parameter | Request parameter names used to populate a JIT-created OCI customer. |
| cXML First/Last Name Extrinsic | Extrinsic names used to populate a JIT-created cXML customer. |
| Company ID | Optional context value for compatible bridge/mapping logic. |
| Price Group ID | Optional context value for compatible pricing/mapping logic. |
| OCI Version | Selects the OCI contract used by this buyer profile. |
| OCI External Product ID Source | Uses Magento SKU or a selected globally unique product attribute for OCI PRODUCTID. |
| OCI External Product ID Attribute | Required when the external product ID source is a product attribute. |
| Mapping Profile | Optional selector limited to active outbound runtime profiles with matching protocol and store scope. Required for controlled mapped output. |
| Active | Allows new requests to resolve this buyer. |
Storefront Entry
- Start Destination is required and selects Shopping Cart, Store Homepage, CMS Page, Category or Store-relative Path.
- CMS Page is required only for the CMS Page destination and is limited to pages available in the selected Store View.
- Category is required only for the Category destination and is resolved in the selected Store View catalog.
- Store-relative Path is required only for the path destination. External URLs are rejected.
Request-specific and Level-2 product destinations take priority over this general entry setting.
Inbound Order Overrides
Every override is optional. An empty value uses the configuration of the buyer's Store view.
| Field | Effect |
|---|---|
| Processing Mode | Overrides acknowledge, validate or create-order behavior for this buyer. |
| Authoritative Price Source | Overrides the Store-view price authority. |
| Returned Cart Line Matching | Selects auxiliary-then-SKU or SKU-only matching. |
| Changed Quantity, New Item, Removed Item, Missing Snapshot | Controls each returned-cart difference independently. |
| Price Mismatch Action and tolerances | Sets buyer-specific unit-price acceptance. |
| Customer, Product and Address Resolution | Changes how the Magento quote context is built. |
| Shipping and Payment Method | Selects buyer-specific quote methods. |
| Update and Cancellation Policy | Controls later OrderRequest revisions and deletes. |
| Send Customer Order Email | Overrides Magento's normal order email setting. |
| Send ConfirmationRequest and Confirmation URL | Controls buyer-specific cXML confirmation delivery. |
| Confirmation Mode | Selects automatic whole-order confirmation or manual decisions for every order line. |
| ASN URL | Overrides the Store-view endpoint for ShipNoticeRequest. It is not the cart-return URL. |
| Invoice URL | Overrides the Store-view endpoint for InvoiceDetailRequest. It is not the cart-return URL. |
| Outbound cXML Response Mode | Allows an empty successful HTTP response or requires a successful cXML response status. |
| Maximum Processing Attempts | Limits processing attempts for this buyer. |
Advanced transport authentication
| Mode | Request value |
|---|---|
| None | No additional transport credential. Protocol credentials are still required. |
| Basic | Authorization: Basic ... using the separately configured username/password. |
| Bearer | Authorization: Bearer ... or X-Punchout-Auth-Token. |
| Shared Secret Header | X-Punchout-Shared-Secret. |
Mapping profile
| Field | Required or effect |
|---|---|
| Store | Required. All Store Views makes the mapping available across stores. |
| Code | Required and unique in scope; lowercase letters, numbers, hyphens and underscores only. |
| Name | Required admin-facing description. |
| Protocol | oci or cxml. |
| Direction | inbound or outbound; buyers can select outbound profiles only. |
| Reusable Template Profile | Marks the profile as a copy source rather than a runtime buyer mapping. Synced system templates can be updated during setup:upgrade. |
| Start From Template | New-profile helper that copies compatible rules; not persisted as a profile relationship. |
| Active | Makes a runtime profile available to buyer configuration. |
Mapping rows contain Data Source Area, Source Value, Punchout Target Key, optional Custom Target Key, Value Formatting, Fallback Value, Mandatory and Export Position.
System configuration
General (punchout/general/*)
| Config path | Admin label | Default |
|---|---|---|
punchout/general/enabled |
Enable Punchout | Yes |
punchout/general/return_action_label |
Punchout return action label | Return to System |
punchout/general/sandbox_mode |
Enable Sandbox Callback Mode | No |
Security (punchout/security/*)
| Config path | Admin label | Default |
|---|---|---|
punchout/security/strict_signature |
Require Strict Signature Validation | No |
punchout/security/signature_secret |
Signature Secret | Empty |
punchout/security/allowed_ips |
Allowed IP Ranges | Empty; permits all source IPs |
punchout/security/allow_request_customer_id_oci |
Allow OCI request customer override | No |
punchout/security/allow_request_customer_id_cxml |
Allow cXML request customer override | No |
punchout/security/allow_insecure_outbound_tls |
Allow insecure outbound TLS in sandbox mode | No |
Cart (punchout/cart/*)
| Config path | Admin label | Default |
|---|---|---|
punchout/cart/allow_inbound_item_prices |
Allow inbound cart item prices | No |
cXML Profile Discovery (punchout/profile/*)
| Config path | Admin label | Default |
|---|---|---|
punchout/profile/enabled |
Enable cXML Profile Discovery | Yes |
punchout/profile/public_base_url |
Public PunchOut Base URL | Empty; uses the Store View base URL |
Customer Identity (punchout/identity/*)
| Config path | Admin label | Default |
|---|---|---|
punchout/identity/jit_enabled |
Enable JIT Customer Provisioning | No |
punchout/identity/jit_customer_group_id |
JIT Customer Group | Empty |
Inbound Orders (punchout/inbound_order/*)
| Config path | Admin label | Default |
|---|---|---|
punchout/inbound_order/processing_mode |
Processing Mode | Acknowledge Only |
punchout/inbound_order/price_source |
Authoritative Price Source | Current Magento Pricing |
punchout/inbound_order/line_match_strategy |
Returned Cart Line Matching | Auxiliary ID, then SKU |
punchout/inbound_order/changed_quantity_action |
Changed Quantity Action | Recalculate with Magento |
punchout/inbound_order/new_item_action |
New Item Action | Recalculate with Magento |
punchout/inbound_order/removed_item_action |
Removed Item Action | Allow Removal |
punchout/inbound_order/missing_snapshot_action |
Missing/Expired Snapshot Action | Reject |
punchout/inbound_order/price_mismatch_action |
Price Mismatch Action | Reject Order |
punchout/inbound_order/price_tolerance_absolute |
Absolute Unit Price Tolerance | 0.01 |
punchout/inbound_order/price_tolerance_percent |
Percent Unit Price Tolerance | 0 |
punchout/inbound_order/customer_resolution |
Customer Resolution | Buyer Profile Customer |
punchout/inbound_order/product_resolution |
Product Resolution | Supplier Part ID |
punchout/inbound_order/address_source |
Address Source | Incoming Order Addresses |
punchout/inbound_order/shipping_method |
Shipping Method | Flat Rate |
punchout/inbound_order/payment_method |
Payment Method | PunchOut Purchase Order |
punchout/inbound_order/update_policy |
Order Update Policy | Manual Review |
punchout/inbound_order/cancellation_policy |
Order Cancellation Policy | Manual Review |
punchout/inbound_order/send_customer_email |
Send Customer Order Email | No |
punchout/inbound_order/confirmation_enabled |
Send cXML ConfirmationRequest | No |
punchout/inbound_order/confirmation_mode |
Confirmation Mode | Automatic Whole-Order Confirmation |
punchout/inbound_order/confirmation_url |
Default Confirmation URL | Empty |
punchout/inbound_order/asn_url |
ASN URL | Empty |
punchout/inbound_order/invoice_url |
Invoice URL | Empty |
punchout/inbound_order/response_mode |
Outbound cXML Response Mode | Allow Empty HTTP 2xx Response |
punchout/inbound_order/supplier_domain |
Supplier Credential Domain | Empty |
punchout/inbound_order/supplier_identity |
Supplier Identity | Empty |
punchout/inbound_order/supplier_shared_secret |
Supplier Shared Secret | Empty |
punchout/inbound_order/max_attempts |
Maximum Processing Attempts | 5 |
punchout/inbound_order/batch_size |
Retry Batch Size | 20 at Default Config |
punchout/inbound_order/retry_delay_minutes |
Retry Delay | 15 minutes |
punchout/inbound_order/retention_days |
Inbound Order Payload Retention (days) | 365 days |
punchout/inbound_order/snapshot_retention_days |
Returned Cart Snapshot Retention | 90 days |
Trace, analytics, debug and session
| Config path | Admin label | Default |
|---|---|---|
punchout/trace/enabled |
Enable Trace Logging | Yes |
punchout/trace/retention_days |
Trace Retention (days) | 30 |
punchout/analytics/enabled |
Enable PunchOut Analytics | Yes |
punchout/debug/enabled |
Enable Debug Logging | No |
punchout/session/token_expiration_hours |
Token Expiration (hours) | 2 |
Debug logging writes technical diagnostics to var/log/punchout.log. It does not write sensitive protocol payloads.
Document Queue (punchout/queue/*)
| Config path | Admin label | Default |
|---|---|---|
punchout/queue/enabled |
Enable Queue Processing | Yes |
punchout/queue/batch_size |
Batch Size per Cron Run | 20 |
punchout/queue/max_retry |
Maximum Retry Attempts | 5 |
punchout/queue/retry_delay_minutes |
Retry Delay (minutes) | 15 |
punchout/queue/retention_days |
Completed Queue Retention (days) | 365 |
Retention
| Config path | Admin label | Default |
|---|---|---|
punchout/request_replay/retention_days |
Request Replay Retention (days) | 7 |
punchout/retention/batch_size |
Cleanup Batch Size | 500 |
Operation Policy (punchout/operation/*)
| Config path | Admin label | Default |
|---|---|---|
punchout/operation/policy_enabled |
Enable Frontend Operation Policy | Yes |
punchout/operation/landing_route |
Restricted Action Landing Route | checkout/cart |
punchout/operation/create_allowed_actions |
Allowed Full Actions for CREATE | * |
punchout/operation/edit_allowed_actions |
Allowed Full Actions for EDIT | * |
punchout/operation/inspect_allowed_actions |
Allowed Full Actions for INSPECT | Cart read and PunchOut return/logout actions |
punchout/operation/detail_allowed_actions |
Allowed Full Actions for DETAIL | Selected product page and session support actions |
punchout/operation/detail_add_allowed_actions |
Allowed Full Actions for DETAILADD | Selected product, Add to Cart and immediate return actions |