From 04bea2b52ce4690119108db740f89631289f308a Mon Sep 17 00:00:00 2001 From: "sumup-release-bot[bot]" <241716704+sumup-release-bot[bot]@users.noreply.github.com> Date: Thu, 20 Aug 2026 12:21:27 +0000 Subject: [PATCH] chore: update CLI code samples for v0.5.0 --- src/codesamples/cli.json | 106 +++++++++++++++++++++------------------ 1 file changed, 58 insertions(+), 48 deletions(-) diff --git a/src/codesamples/cli.json b/src/codesamples/cli.json index e2ed7bd7..1f243fa9 100644 --- a/src/codesamples/cli.json +++ b/src/codesamples/cli.json @@ -3,7 +3,7 @@ "language": "bash", "sdk": { "module": "github.com/sumup/sumup-cli", - "version": "v0.4.1" + "version": "v0.5.0" }, "openAPIVersion": "1.0.0", "samples": [ @@ -14,16 +14,17 @@ "description": "Creates an Apple Pay merchant session for the specified checkout.\n\nUse this endpoint after the customer selects Apple Pay and before calling\n`ApplePaySession.completeMerchantValidation(...)` in the browser.\nSumUp validates the merchant session request and returns the Apple Pay\nsession object that your frontend should pass to Apple's JavaScript API.", "httpMethod": "PUT", "path": "/v0.2/checkouts/{checkout_id}/apple-pay-session", - "sample": "sumup checkouts apple-pay-session \"$CHECKOUT_ID\" \\\n --context \"example.com\" \\\n --target \"https://apple-pay-gateway-cert.apple.com/paymentservices/startSession\"\n" + "sample": "sumup checkouts apple-pay-session \"4e425463-3e1b-431d-83fa-1e51c2925e99\" \\\n --context \"example.com\" \\\n --target \"https://apple-pay-gateway-cert.apple.com/paymentservices/startSession\"\n" }, { "id": "CreateCheckout", "operationId": "CreateCheckout", + "example": "Checkout", "summary": "Create a checkout", - "description": "Creates a new payment checkout resource. The unique `checkout_reference` created by this request, is used for further manipulation of the checkout.\n\nFor 3DS checkouts, add the `redirect_url` parameter to your request body schema.\nTo use the [Hosted Checkout](https://developer.sumup.com/online-payments/checkouts/hosted-checkout/) page, set the `hosted_checkout.enabled` to `true`.\n\nFollow by processing a checkout to charge the provided payment instrument.", + "description": "Standard request body for creating a checkout", "httpMethod": "POST", "path": "/v0.1/checkouts", - "sample": "sumup checkouts create \\\n --reference \"order-123\" \\\n --amount \"10.00\" \\\n --currency \"EUR\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup checkouts create \\\n --reference \"f00a8f74-b05d-4605-bd73-2a901bae5802\" \\\n --amount \"10.1\" \\\n --currency \"EUR\" \\\n --merchant-code \"MH4H92C7\" \\\n --description \"Purchase\" \\\n --redirect-url \"https://sumup.com\" \\\n --valid-until \"2020-02-29T10:56:56+00:00\"\n" }, { "id": "CreateCustomer", @@ -32,7 +33,16 @@ "description": "Creates a new saved customer resource which you can later manipulate and save payment instruments to.", "httpMethod": "POST", "path": "/v0.1/customers", - "sample": "sumup customers create \\\n --email \"customer@example.com\"\n" + "sample": "sumup customers create \\\n --first-name \"John\" \\\n --last-name \"Doe\" \\\n --email \"user@example.com\" \\\n --phone \"+491635559723\" \\\n --tax-id \"423.378.593-47\" \\\n --birth-date \"1993-12-31\" \\\n --address-line-1 \"Sample street\" \\\n --address-line-2 \"ap. 5\" \\\n --address-city \"Berlin\" \\\n --address-postal-code \"10115\" \\\n --address-state \"Berlin\" \\\n --address-country \"DE\"\n" + }, + { + "id": "CreateGoReaderCheckout", + "operationId": "CreateGoReaderCheckout", + "summary": "Create a Go Reader Payment", + "description": "Initiates a payment on the SumUp Go terminal identified by the reader ID.\n\nUse `client_transaction_id` as an idempotency key: retrying the request with the same value returns the result of the original payment instead of creating a duplicate.", + "httpMethod": "POST", + "path": "/v0/merchants/{merchant_code}/readers/{reader_id}/go-checkout", + "sample": "sumup readers go-checkout \"rdr_3MSAFM23CK82VSTT4BN6RWSQ65\" \\\n --merchant-code \"MK10CL2A\" \\\n --amount \"10\" \\\n --currency \"EUR\" \\\n --client-transaction-id \"19e12390-72cf-4f9f-80b5-b0c8a67fa43f\" \\\n --tip-amount \"1\" \\\n --affiliate-app-id \"com.example.app\" \\\n --affiliate-key \"123e4567-e89b-12d3-a456-426614174000\"\n" }, { "id": "CreateMerchantMember", @@ -41,7 +51,7 @@ "description": "Create a merchant member.", "httpMethod": "POST", "path": "/v0.1/merchants/{merchant_code}/members", - "sample": "sumup members create \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\" \\\n --email \"member@example.com\" \\\n --password \"$MEMBER_PASSWORD\" \\\n --role \"role_employee\"\n" + "sample": "sumup members create \\\n --merchant-code \"MK10CL2A\" \\\n --email \"karl.berg@example.com\" \\\n --password \"secret\" \\\n --role \"role_employee\"\n" }, { "id": "CreateMerchantRole", @@ -50,7 +60,7 @@ "description": "Create a custom role for the merchant. Roles are defined by the set of permissions that they grant to the members that they are assigned to.", "httpMethod": "POST", "path": "/v0.1/merchants/{merchant_code}/roles", - "sample": "sumup roles create \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\" \\\n --name \"Example\" \\\n --permission \"members_access\"\n" + "sample": "sumup roles create \\\n --merchant-code \"MK10CL2A\" \\\n --name \"Senior Shop Manager II\" \\\n --permission \"catalog_access\" \\\n --permission \"taxes_access\" \\\n --permission \"members_access\" \\\n --description \"Manges the shop and the employees.\"\n" }, { "id": "CreateReader", @@ -59,7 +69,7 @@ "description": "Create a new Reader for the merchant account.", "httpMethod": "POST", "path": "/v0.1/merchants/{merchant_code}/readers", - "sample": "sumup readers add \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\" \\\n --pairing-code \"4WLFDSBF\" \\\n --name \"Example\"\n" + "sample": "sumup readers add \\\n --merchant-code \"MK10CL2A\" \\\n --pairing-code \"4WLFDSBF\" \\\n --name \"Frontdesk\"\n" }, { "id": "CreateReaderCheckout", @@ -68,7 +78,7 @@ "description": "Creates a Checkout for a Reader.\n\nThis process is asynchronous and the actual transaction may take some time to be started on the device.\n\n\nThere are some caveats when using this endpoint:\n* The target device must be online, otherwise checkout won't be accepted\n* After the checkout is accepted, the system has 60 seconds to start the payment on the target device. During this time, any other checkout for the same device will be rejected.\n\n\n**Note**: If the target device is a Solo, it must be in version 3.3.24.3 or higher.", "httpMethod": "POST", "path": "/v0.1/merchants/{merchant_code}/readers/{reader_id}/checkout", - "sample": "sumup readers checkout \"$READER_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\" \\\n --amount \"10.00\" \\\n --currency \"EUR\"\n" + "sample": "sumup readers checkout \"rdr_3MSAFM23CK82VSTT4BN6RWSQ65\" \\\n --merchant-code \"MC0X0ABC\" \\\n --amount \"50.33\" \\\n --minor-unit \"2\" \\\n --currency \"EUR\" \\\n --description \"This is a description...\" \\\n --return-url \"https://webhook.site/e21ddbb0-42c4-4358-a981-f5a95cd86fb5\" \\\n --card-type \"debit\" \\\n --installments \"1\" \\\n --tip-timeout \"60\" \\\n --tip-rate \"0.05\" \\\n --tip-rate \"0.1\" \\\n --tip-rate \"0.15\" \\\n --affiliate-app-id \"com.example.app\" \\\n --affiliate-key \"ef7b684a-d6f4-4e93-9b1b-6acdd6564a8e\" \\\n --affiliate-foreign-transaction-id \"123456\"\n" }, { "id": "CreateReaderTerminate", @@ -77,7 +87,7 @@ "description": "Terminate a Reader Checkout stops the current transaction on the target device.\n\nThis process is asynchronous and the actual termination may take some time to be performed on the device.\n\n\nThere are some caveats when using this endpoint:\n* The target device must be online, otherwise terminate won't be accepted\n* The action will succeed only if the device is waiting for cardholder action: e.g: waiting for card, waiting for PIN, etc.\n* There is no confirmation of the termination.\n\nIf a transaction is successfully terminated and `return_url` was provided on Checkout, the transaction status will be sent as `failed` to the provided URL.\n\n\n**Note**: If the target device is a Solo, it must be in version 3.3.28.0 or higher.", "httpMethod": "POST", "path": "/v0.1/merchants/{merchant_code}/readers/{reader_id}/terminate", - "sample": "sumup readers terminate \"$READER_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup readers terminate \"rdr_3MSAFM23CK82VSTT4BN6RWSQ65\" \\\n --merchant-code \"MC0X0ABC\"\n" }, { "id": "DeactivateCheckout", @@ -86,7 +96,7 @@ "description": "Deactivates an identified checkout resource. If the checkout has already been processed it can not be deactivated.", "httpMethod": "DELETE", "path": "/v0.1/checkouts/{checkout_id}", - "sample": "sumup checkouts deactivate \"$CHECKOUT_ID\"\n" + "sample": "sumup checkouts deactivate \"4e425463-3e1b-431d-83fa-1e51c2925e99\"\n" }, { "id": "DeactivatePaymentInstrument", @@ -95,7 +105,7 @@ "description": "Deactivates an identified card payment instrument resource for a customer.", "httpMethod": "DELETE", "path": "/v0.1/customers/{customer_id}/payment-instruments/{token}", - "sample": "sumup customers payment-instruments deactivate \"$CUSTOMER_ID\" \"$PAYMENT_INSTRUMENT_TOKEN\"\n" + "sample": "sumup customers payment-instruments deactivate \"831ff8d4cd5958ab5670\" \"bcfc8e5f-3b47-4cb9-854b-3b7a4cce7be3\"\n" }, { "id": "DeleteMerchantMember", @@ -104,7 +114,7 @@ "description": "Deletes a merchant member.", "httpMethod": "DELETE", "path": "/v0.1/merchants/{merchant_code}/members/{member_id}", - "sample": "sumup members delete \"$MEMBER_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup members delete \"mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP\" \\\n --merchant-code \"MK10CL2A\"\n" }, { "id": "DeleteMerchantRole", @@ -113,7 +123,7 @@ "description": "Delete a custom role.", "httpMethod": "DELETE", "path": "/v0.1/merchants/{merchant_code}/roles/{role_id}", - "sample": "sumup roles delete \"$ROLE_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup roles delete \"role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP\" \\\n --merchant-code \"MK10CL2A\"\n" }, { "id": "DeleteReader", @@ -122,7 +132,7 @@ "description": "Delete a reader.", "httpMethod": "DELETE", "path": "/v0.1/merchants/{merchant_code}/readers/{reader_id}", - "sample": "sumup readers delete \"$READER_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup readers delete \"rdr_3MSAFM23CK82VSTT4BN6RWSQ65\" \\\n --merchant-code \"MK10CL2A\"\n" }, { "id": "GetCheckout", @@ -131,7 +141,7 @@ "description": "Retrieves an identified checkout resource. Use this request after processing a checkout to confirm its status and inform the end user respectively.", "httpMethod": "GET", "path": "/v0.1/checkouts/{checkout_id}", - "sample": "sumup checkouts get \"$CHECKOUT_ID\"\n" + "sample": "sumup checkouts get \"4e425463-3e1b-431d-83fa-1e51c2925e99\"\n" }, { "id": "GetCustomer", @@ -140,7 +150,7 @@ "description": "Retrieves an identified saved customer resource through the unique `customer_id` parameter, generated upon customer creation.", "httpMethod": "GET", "path": "/v0.1/customers/{customer_id}", - "sample": "sumup customers get \"$CUSTOMER_ID\"\n" + "sample": "sumup customers get \"831ff8d4cd5958ab5670\"\n" }, { "id": "GetMerchant", @@ -149,7 +159,7 @@ "description": "Returns a Merchant for a valid Merchant code.", "httpMethod": "GET", "path": "/v1/merchants/{merchant_code}", - "sample": "sumup merchants get \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup merchants get \\\n --merchant-code \"MK10CL2A\"\n" }, { "id": "GetMerchantMember", @@ -158,7 +168,7 @@ "description": "Retrieve a merchant member.", "httpMethod": "GET", "path": "/v0.1/merchants/{merchant_code}/members/{member_id}", - "sample": "sumup members get \"$MEMBER_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup members get \"mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP\" \\\n --merchant-code \"MK10CL2A\"\n" }, { "id": "GetMerchantRole", @@ -167,7 +177,7 @@ "description": "Retrieve a custom role by ID.", "httpMethod": "GET", "path": "/v0.1/merchants/{merchant_code}/roles/{role_id}", - "sample": "sumup roles get \"$ROLE_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup roles get \"role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP\" \\\n --merchant-code \"MK10CL2A\"\n" }, { "id": "GetPaymentMethods", @@ -176,7 +186,7 @@ "description": "Get payment methods available for the given merchant to use with a checkout.", "httpMethod": "GET", "path": "/v0.1/merchants/{merchant_code}/payment-methods", - "sample": "sumup checkouts payment-methods \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup checkouts payment-methods \\\n --merchant-code \"MH4H92C7\"\n" }, { "id": "GetPerson", @@ -185,7 +195,7 @@ "description": "Returns a single Person related to a Merchant.", "httpMethod": "GET", "path": "/v1/merchants/{merchant_code}/persons/{person_id}", - "sample": "sumup merchants persons get \"$PERSON_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup merchants persons get \"pers_5AKFHN2KSK8D3TS79DJE3P3A2Z\" \\\n --merchant-code \"MK10CL2A\"\n" }, { "id": "GetReader", @@ -194,7 +204,16 @@ "description": "Retrieve a Reader.", "httpMethod": "GET", "path": "/v0.1/merchants/{merchant_code}/readers/{reader_id}", - "sample": "sumup readers get \"$READER_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup readers get \"rdr_3MSAFM23CK82VSTT4BN6RWSQ65\" \\\n --merchant-code \"MK10CL2A\"\n" + }, + { + "id": "GetReaderCheckout", + "operationId": "GetReaderCheckout", + "summary": "Get a Reader Checkout", + "description": "Get a Checkout for a Reader.", + "httpMethod": "GET", + "path": "/v0.1/merchants/{merchant_code}/readers/{reader_id}/checkout/{checkout_id}", + "sample": "sumup readers get-checkout \"rdr_3MSAFM23CK82VSTT4BN6RWSQ65\" \"74ecff66-1655-43ed-8ce3-193f49fa602f\" \\\n --merchant-code \"MC0X0ABC\"\n" }, { "id": "GetReaderStatus", @@ -203,7 +222,7 @@ "description": "Provides the last known status for a Reader.\n\nThis endpoint allows you to retrieve updates from the connected card reader, including the current screen being displayed during the payment process and the device status (battery level, connectivity, and update state).\n\nSupported States\n\n* `IDLE` – Reader ready for next transaction\n* `SELECTING_TIP` – Waiting for tip input\n* `WAITING_FOR_CARD` – Awaiting card insert/tap\n* `WAITING_FOR_PIN` – Waiting for PIN entry\n* `WAITING_FOR_SIGNATURE` – Waiting for customer signature\n* `UPDATING_FIRMWARE` – Firmware update in progress\n\nDevice Status\n\n* `ONLINE` – Device connected and operational\n* `OFFLINE` – Device disconnected (last state persisted)\n\n**Note**: If the target device is a Solo, it must be in version 3.3.39.0 or higher.", "httpMethod": "GET", "path": "/v0.1/merchants/{merchant_code}/readers/{reader_id}/status", - "sample": "sumup readers status \"$READER_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup readers status \"rdr_3MSAFM23CK82VSTT4BN6RWSQ65\" \\\n --merchant-code \"MC0X0ABC\"\n" }, { "id": "GetReceipt", @@ -212,7 +231,7 @@ "description": "Retrieves receipt specific data for a transaction.", "httpMethod": "GET", "path": "/v1.1/receipts/{transaction_id}", - "sample": "sumup receipts get \"$TRANSACTION_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup receipts get \"410fc44a-5956-44e1-b5cc-19c6f8d727a4\"\n" }, { "id": "GetTransactionV2.1", @@ -221,7 +240,7 @@ "description": "Retrieves the full details of an identified transaction. The transaction resource is identified by a query parameter and *one* of following parameters is required:\n- `id`\n- `transaction_code`\n- `foreign_transaction_id`\n- `client_transaction_id`", "httpMethod": "GET", "path": "/v2.1/merchants/{merchant_code}/transactions", - "sample": "sumup transactions get \"$TRANSACTION_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup transactions get \"410fc44a-5956-44e1-b5cc-19c6f8d727a4\" \\\n --merchant-code \"MH4H92C7\"\n" }, { "id": "ListCheckouts", @@ -248,7 +267,7 @@ "description": "Lists merchant members.", "httpMethod": "GET", "path": "/v0.1/merchants/{merchant_code}/members", - "sample": "sumup members list \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup members list \\\n --merchant-code \"MK10CL2A\"\n" }, { "id": "ListMerchantRoles", @@ -257,7 +276,7 @@ "description": "List merchant's custom roles.", "httpMethod": "GET", "path": "/v0.1/merchants/{merchant_code}/roles", - "sample": "sumup roles list \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup roles list \\\n --merchant-code \"MK10CL2A\"\n" }, { "id": "ListPaymentInstruments", @@ -266,7 +285,7 @@ "description": "Lists all payment instrument resources that are saved for an identified customer.", "httpMethod": "GET", "path": "/v0.1/customers/{customer_id}/payment-instruments", - "sample": "sumup customers payment-instruments list \"$CUSTOMER_ID\"\n" + "sample": "sumup customers payment-instruments list \"831ff8d4cd5958ab5670\"\n" }, { "id": "ListPayoutsV1", @@ -275,7 +294,7 @@ "description": "Lists payout and payout-deduction records for the specified merchant account within the requested date range.\n\nThe response can include:\n- regular payouts (`type = PAYOUT`)\n- deduction records for refunds, chargebacks, direct debit returns, or balance adjustments\n\nResults are sorted by payout date in the requested `order`.", "httpMethod": "GET", "path": "/v1.0/merchants/{merchant_code}/payouts", - "sample": "sumup payouts list \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\" \\\n --start-date \"2026-01-01\" \\\n --end-date \"2026-01-31\"\n" + "sample": "sumup payouts list \\\n --merchant-code \"MH4H92C7\" \\\n --start-date \"2024-02-01\" \\\n --end-date \"2024-02-29\"\n" }, { "id": "ListPersons", @@ -284,7 +303,7 @@ "description": "Returns the Persons related to a Merchant.", "httpMethod": "GET", "path": "/v1/merchants/{merchant_code}/persons", - "sample": "sumup merchants persons list \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup merchants persons list \\\n --merchant-code \"MK10CL2A\"\n" }, { "id": "ListReaders", @@ -293,7 +312,7 @@ "description": "List all readers of the merchant.", "httpMethod": "GET", "path": "/v0.1/merchants/{merchant_code}/readers", - "sample": "sumup readers list \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup readers list \\\n --merchant-code \"MK10CL2A\"\n" }, { "id": "ListTransactionsV2.1", @@ -302,16 +321,7 @@ "description": "Lists detailed history of all transactions associated with the merchant profile.", "httpMethod": "GET", "path": "/v2.1/merchants/{merchant_code}/transactions/history", - "sample": "sumup transactions list \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" - }, - { - "id": "ProcessCheckout", - "operationId": "ProcessCheckout", - "summary": "Process a checkout", - "description": "Processing a checkout will attempt to charge the provided payment instrument for the amount of the specified checkout resource initiated in the `Create a checkout` endpoint.\n\nFollow this request with `Retrieve a checkout` to confirm its status.", - "httpMethod": "PUT", - "path": "/v0.1/checkouts/{checkout_id}", - "sample": "sumup checkouts process \"$CHECKOUT_ID\" \\\n --payment-type \"card\" \\\n --customer-id \"$CUSTOMER_ID\" \\\n --token \"$PAYMENT_INSTRUMENT_TOKEN\"\n" + "sample": "sumup transactions list \\\n --merchant-code \"MH4H92C7\"\n" }, { "id": "RefundTransaction", @@ -320,7 +330,7 @@ "description": "Refunds an identified transaction either in full or partially.", "httpMethod": "POST", "path": "/v1.0/merchants/{merchant_code}/payments/{transaction_id}/refunds", - "sample": "sumup transactions refund \"$TRANSACTION_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\"\n" + "sample": "sumup transactions refund \"4ffb8dfc-7f2b-413d-a497-2ad00766585e\" \\\n --merchant-code \"MH4H92C7\" \\\n --amount \"5\"\n" }, { "id": "UpdateCheckout", @@ -329,7 +339,7 @@ "description": "Updates an identified checkout resource.", "httpMethod": "PATCH", "path": "/v0.1/checkouts/{checkout_id}", - "sample": "sumup checkouts update \"$CHECKOUT_ID\" \\\n --description \"Updated order\"\n" + "sample": "sumup checkouts update \"4e425463-3e1b-431d-83fa-1e51c2925e99\" \\\n --reference \"f00a8f74-b05d-4605-bd73-2a901bae5802\" \\\n --amount \"12.5\" \\\n --currency \"EUR\" \\\n --description \"Updated purchase\" \\\n --customer-id \"831ff8d4cd5958ab5670\" \\\n --valid-until \"2020-02-29T10:56:56+00:00\"\n" }, { "id": "UpdateCustomer", @@ -338,7 +348,7 @@ "description": "Updates an identified saved customer resource's personal details.\n\nThe request only overwrites the parameters included in the request, all other parameters will remain with their initially assigned values.", "httpMethod": "PUT", "path": "/v0.1/customers/{customer_id}", - "sample": "sumup customers update \"$CUSTOMER_ID\" \\\n --email \"updated-customer@example.com\"\n" + "sample": "sumup customers update \"831ff8d4cd5958ab5670\" \\\n --first-name \"John\" \\\n --last-name \"Doe\" \\\n --email \"user@example.com\" \\\n --phone \"+491635559723\" \\\n --tax-id \"423.378.593-47\" \\\n --birth-date \"1993-12-31\" \\\n --address-line-1 \"Sample street\" \\\n --address-line-2 \"ap. 5\" \\\n --address-city \"Berlin\" \\\n --address-postal-code \"10115\" \\\n --address-state \"Berlin\" \\\n --address-country \"DE\"\n" }, { "id": "UpdateMerchantMember", @@ -347,7 +357,7 @@ "description": "Update the merchant member.", "httpMethod": "PUT", "path": "/v0.1/merchants/{merchant_code}/members/{member_id}", - "sample": "sumup members update \"$MEMBER_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\" \\\n --role \"role_employee\"\n" + "sample": "sumup members update \"mem_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP\" \\\n --merchant-code \"MK10CL2A\" \\\n --role \"role_manager\" \\\n --nickname \"New Employee Name\"\n" }, { "id": "UpdateMerchantRole", @@ -356,7 +366,7 @@ "description": "Update a custom role.", "httpMethod": "PATCH", "path": "/v0.1/merchants/{merchant_code}/roles/{role_id}", - "sample": "sumup roles update \"$ROLE_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\" \\\n --name \"Payment reviewer\"\n" + "sample": "sumup roles update \"role_WZsm7QTPhVrompscmPhoGTXXcrd58fr9MOhP\" \\\n --merchant-code \"MK10CL2A\" \\\n --name \"Senior Shop Manager III\" \\\n --permission \"catalog_edit\" \\\n --permission \"taxes_access\" \\\n --permission \"members_edit\"\n" }, { "id": "UpdateReader", @@ -365,7 +375,7 @@ "description": "Update a Reader.", "httpMethod": "PATCH", "path": "/v0.1/merchants/{merchant_code}/readers/{reader_id}", - "sample": "sumup readers update \"$READER_ID\" \\\n --merchant-code \"$SUMUP_MERCHANT_CODE\" \\\n --name \"Example\"\n" + "sample": "sumup readers update \"rdr_3MSAFM23CK82VSTT4BN6RWSQ65\" \\\n --merchant-code \"MK10CL2A\" \\\n --name \"Frontdesk\"\n" } ] }