Edit customer
Edit the customer details.
- Example Request
- Example Response
curl -X POST \
-H 'authorization: Bearer v4.public.eyJpc3MiOiJs...' \
-H 'content-type: application/json' \
-H 'Idempotency-Key: da7ca8f9-915b-472b-b5f0-81945bff9e4a' \
-d '{
"billingAddress": {
"attentionName": "",
"careOf": "",
"city": "Stockholm",
"companyName": "Ledyer AB",
"country": "SE",
"postalCode": "11359",
"streetAddress": "Sveavägen 49"
},
"email": "jan.jonsson@business.com",
"invoiceChannel": {
"details": "a detail",
},
"phone": "004613371337",
"reference1": "ref #1",
"reference2": "ref #2",
"shippingAddress": {
"attentionName": "Anders",
"careOf": "",
"city": "Stockholm",
"companyName": "Ledyer AB",
"contact": {
"email": "anders.andersson@example.com",
"firstName": "Anders",
"lastName": "Andersson",
"phone": "004612341234"
},
"country": "SE",
"postalCode": "11359",
"streetAddress": "Sveavägen 49"
}
}'
https://api.sandbox.ledyer.com/v1/orders/:orderId/customer
Request Headers
Idempotency-Key
stringOptionalBy providing a unique value for this header, the idempotency of the operation will be guaranteed. This means that retries of requests will be safe to apply in case of network errors, socket errors and timeouts, etc. We recommend using UUID version 4 for the key.
Path parameters
orderId
The order ID string that was obtained when the order session was created.
Request body
billingAddress
companyAddressOptionalThe billing address. Replaces the existing shipping address for the customer.
The customer's email address.
invoiceChannel
objectOptionalAn object containing the property details
, which is a string.
phone
stringOptionalThe customer's phone number.
reference1
stringOptionalMerchant reference 1. For example, reference code or cost center.
reference2
stringOptionalMerchant reference 2. For example, purchase order number.
shippingAddress
companyAddressOptionalThe shipping address. Replaces the existing shipping address for the customer.
{
"authorizeStatus": "authorized",
"captured": [],
"capturedAmount": {
"amount": "0.00",
"currency": "SEK",
"formatted": "0.00",
"formattedWithCurrency": "SEK 0.00",
"minorUnits": 0
},
"createdAt": "2023-02-10T21:28:17.425663Z",
"customer": {
"billingAddress": {
"attentionName": "",
"careOf": "",
"city": "Stockholm",
"companyName": "Ledyer AB",
"country": "SE",
"postalCode": "11359",
"streetAddress": "Sveavägen 49"
},
"companyId": "559311-3714",
"companyName": "Ledyer AB",
"email": "jan.jonsson@business.com",
"firstName": "Jan",
"invoiceChannel": {
"details": "a detail",
"type": "email"
},
"lastName": "Jonsson",
"paymentMethod": {
"provider": "ledyer",
"type": "invoice"
},
"phone": "004613371337",
"reference1": "ref #1",
"reference2": "ref #2",
"shippingAddress": {
"attentionName": "Anders",
"careOf": "",
"city": "Stockholm",
"companyName": "Ledyer AB",
"contact": {
"email": "anders.andersson@example.com",
"firstName": "Anders",
"lastName": "Andersson",
"phone": "004612341234"
},
"country": "SE",
"postalCode": "11359",
"streetAddress": "Sveavägen 49"
}
},
"events": [
{
"amount": {
"amount": "0.00",
"currency": "SEK",
"formatted": "0.00",
"formattedWithCurrency": "SEK 0.00",
"minorUnits": 0
},
"createdAt": "2023-02-10T21:28:21.992588Z",
"id": "oe_24w4qABgHvVTEtuebc5MIvqnplx",
"ledgerId": "in_24w4pVQQYYEMRKJy4VhBmiay4qw",
"orderId": "or_24w4p5pJogDfyMevIEddZLqyXMG",
"type": "editCustomer"
},
{
"amount": {
"amount": "0.00",
"currency": "SEK",
"formatted": "0.00",
"formattedWithCurrency": "SEK 0.00",
"minorUnits": 0
},
"createdAt": "2023-02-10T21:28:18.425663Z",
"id": "oe_24w4pSYb70kRiEu7FnlQ0ck3iV8",
"ledgerId": "in_24w4pVQQYYEMRKJy4VhBmiay4qw",
"orderId": "or_24w4p5pJogDfyMevIEddZLqyXMG",
"type": "readyForCapture"
},
{
"amount": {
"amount": "4600.00",
"currency": "SEK",
"formatted": "4,600.00",
"formattedWithCurrency": "SEK 4,600.00",
"minorUnits": 460000
},
"createdAt": "2023-02-10T21:28:17.425663Z",
"id": "oe_24w4pSYb70kRiEu7FnlQ0ck3iV8",
"ledgerId": "in_24w4pVQQYYEMRKJy4VhBmiay4qw",
"orderId": "or_24w4p5pJogDfyMevIEddZLqyXMG",
"type": "create"
}
],
"expiresAt": "2023-02-24T21:28:17.425663Z",
"id": "or_24w4p5pJogDfyMevIEddZLqyXMG",
"merchantId": "ac_1xWqkkS5aIbxCJsoseRhSd0OJyD",
"merchantReference": "or_24w4p5pJogDfyMevIEddZLqyXMG",
"orderAmount": {
"amount": "4600.00",
"currency": "SEK",
"formatted": "4,600.00",
"formattedWithCurrency": "SEK 4,600.00",
"minorUnits": 460000
},
"orderReference": "DXXX5HYZ",
"paymentMethod": {
"provider": "ledyer",
"type": "invoice"
},
"refunded": [],
"refundedAmount": {
"amount": "0.00",
"currency": "SEK",
"formatted": "0.00",
"formattedWithCurrency": "SEK 0.00",
"minorUnits": 0
},
"riskProfile": {
"tags": []
},
"status": ["uncaptured"],
"storeId": "970245072",
"uncaptured": {
"availableActions": [
{
"type": "cancel"
},
{
"type": "capture"
},
{
"type": "partialCapture"
},
{
"type": "editCustomer"
},
{
"type": "editOrder"
},
{
"type": "extendOrderExpiry"
}
],
"createdAt": "2023-02-10T21:28:17.425663541Z",
"ledgerId": "in_24w4pVQQYYEMRKJy4VhBmiay4qw",
"note": "",
"orderLines": [
{
"id": "ol_274BCHVWsZhUyROkVCzMJf7iz5V",
"description": "Coffee Machine X200",
"quantity": 9,
"reference": "111-222-333",
"totalAmount": 450000,
"totalVatAmount": 90000,
"type": "physical",
"unitPrice": 50000,
"vat": 2500
},
{
"id": "ol_274BCKxRHZHzzRPADiBH9txmmO2",
"description": "Shipping fee",
"quantity": 1,
"reference": "444-555-666",
"totalAmount": 10000,
"totalVatAmount": 2000,
"type": "shippingFee",
"unitPrice": 10000,
"vat": 2500
}
],
"status": [],
"totalOrderAmount": {
"amount": "4600.00",
"currency": "SEK",
"formatted": "4,600.00",
"formattedWithCurrency": "SEK 4,600.00",
"minorUnits": 460000
},
"totalOrderAmountExclVat": {
"amount": "3680.00",
"currency": "SEK",
"formatted": "3,680.00",
"formattedWithCurrency": "SEK 3,680.00",
"minorUnits": 368000
},
"totalOrderVatAmount": {
"amount": "920.00",
"currency": "SEK",
"formatted": "920.00",
"formattedWithCurrency": "SEK 920.00",
"minorUnits": 92000
}
},
"uncapturedAmount": {
"amount": "4600.00",
"currency": "SEK",
"formatted": "4,600.00",
"formattedWithCurrency": "SEK 4,600.00",
"minorUnits": 460000
},
"updatedAt": "2023-02-10T21:28:21.992588Z"
}
customer.billingAddress
companyAddressThe billing address. Replaces the existing shipping address for the customer.
customer.email
stringThe customer's email address. Replaces the existing email address for the customer.
customer.invoiceChannel
objectAn object containing the properties details
, a string, and type
, which is either an email address or a GLN number.
customer.phone
stringThe customer's phone number. Replaces the existing phone number for the customer.
customer.reference1
stringMerchant reference 1. For example, reference code or cost center.
customer.reference2
stringMerchant reference 2. For example, purchase order number.
customer.shippingAddress
companyAddressThe shipping address. Replaces the existing shipping address for the customer.
events
array of eventsA list of event objects, or snapshots on the order.
Each object contains an amount
object with the strings amount
, currency
formatted
, formattedWithCurrency
and integer minorUnits
pertaining to the event.
The event object also contains the date string createdAt
as well as orderId
and ledgerId
, and finally the event type
.
Events can have one of the following types:
acknowledge
: Order has been acknowledged.authorize
: Order has been authorized.cancel
: Order has been cancelled.create
: Order has been created.edit
: The order lines etc have been edited since first authorized.editCustomer
: The customer details of the order have been edited.editPaymentMethod
: The payment method of the order has been changed.extendExpiry
: The expiry date of the order has been extended at least once.fullCapture
: All order lines have been captured.fullRefund
: All order lines have been added to a credit invoice.paid
: Order has been paid.partialCapture
: Some of the order lines have been captured.partialRefund
: Some of the order lines have been added to a credit invoice.readyForCapture
: Order has been made ready for capture.setReference
: The merchant's order reference has been updated.
updatedAt
stringThe timestamp of the latest added event under events
.