Skip to main content

Fields

clientParams : JSONString

Client parameters of the purchase.

code : String

Purchase code.

goodsGrants : [GoodsGrant]

Grants that apply in this purchase.

goodsSaleItems : [GoodsSaleItem]

Sale items in this purchase.

ledgerId : ID

Ledger ID associated to the purchase.

Deprecation
The 'ledgerId' field is deprecated.

Please use 'ledgerNumber' instead. This is in the form of 'L-123456789A'

- Marked as deprecated on 2024-10-22.
- Scheduled for removal on or after 2025-06-25.
ledgerNumber : String

The ledger number associated to the purchase.

marketName : String! required

Market name of the purchase.

marketParams : JSONString

Market parameters of the purchase.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "clientParams": {"key": "value"}, "code": "easy-sing-radio-land-involve", "goodsGrants": [GoodsGrant], "goodsSaleItems": [GoodsSaleItem], "ledgerNumber": "economic-keep-Mrs-action-student", "marketName": "commercial-magazine-soldier-usually-wish", "marketParams": {"key": "value"} }