Order Approval

Endpoints for Order Approval addon

Order Approval addon

Count Pending Order Approvals

get

Returns the count of pending order approvals for the current customer (excluding approved, declined, and ordered states). Requires admin permission.

Authorizations

sw-context-tokenstringRequired

Responses

200

Count of pending order approvals

application/json

countintegerOptional

Number of pending order approvals

401

Employee not logged in

403

Admin permission required

get

/b2b/order-approval/settings/count-pending

GET /b2b/order-approval/settings/count-pending HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

{
  "count": 1
}

Execute Order Approval

post

Executes an approved order approval by creating a real Shopware order. Requires employee login and the order approval must be in 'approved' state. Automatically refreshes the cart before execution to ensure latest prices and stock.

Authorizations

sw-context-tokenstringRequired

Path parameters

orderApprovalIdstringRequired

Order Approval ID

Body

skipRefreshbooleanOptional

Skip automatic refresh before execution (default: false). Not recommended unless you know what you're doing.

Default: false

Responses

200

Order Approval executed successfully

application/json

400

Invalid request data or order approval cannot be executed

401

Employee not logged in

403

Employee not allowed to execute this order approval

404

Order Approval not found

post

/b2b/order-approval/{orderApprovalId}/execute

POST /b2b/order-approval/{orderApprovalId}/execute HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "skipRefresh": false
}

{
  "executionResult": {
    "success": true,
    "orderId": "text",
    "orderNumber": "text",
    "paymentUrl": "text",
    "requiresPaymentAction": true,
    "errorMessage": "text",
    "errors": [
      "text"
    ],
    "warnings": [
      "text"
    ]
  }
}

Update Pending Order Approvals with New Settings

post

Updates all pending order approvals for the current customer with new approval settings. This ensures that existing open order approvals use the latest approval configuration instead of outdated settings. Requires admin permission.

Authorizations

sw-context-tokenstringRequired

Responses

200

Pending order approvals updated successfully

application/json

updatedCountintegerOptional

Number of order approvals that were updated

401

Employee not logged in

403

Admin permission required

post

/b2b/order-approval/settings/update-pending

POST /b2b/order-approval/settings/update-pending HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

{
  "updatedCount": 1
}

Remind Single Approver

post

Sends a reminder email to a specific approver for an order approval.

Authorizations

sw-context-tokenstringRequired

Path parameters

orderApprovalIdstringRequired

Order Approval ID

Body

approverIdstringRequired

Employee ID of the approver to remind

Responses

200

Reminder sent successfully

application/json

remindersSentintegerOptional

approverIdstringOptional

400

Invalid request data

401

Customer not logged in

404

Order Approval or Approver not found

post

/b2b/order-approval/{orderApprovalId}/remind

POST /b2b/order-approval/{orderApprovalId}/remind HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "approverId": "text"
}

{
  "remindersSent": 1,
  "approverId": "text"
}

Remind All Approvers

post

Sends reminder emails to all pending approvers for an order approval.

Authorizations

sw-context-tokenstringRequired

Path parameters

orderApprovalIdstringRequired

Order Approval ID

Responses

200

Reminders sent successfully

application/json

remindersSentintegerOptional

400

Invalid request data

401

Customer not logged in

404

Order Approval not found

post

/b2b/order-approval/{orderApprovalId}/remind/all

POST /b2b/order-approval/{orderApprovalId}/remind/all HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

{
  "remindersSent": 1
}

Delete Order Approval Line Item

post

Deletes a line item from an order approval. Requires employee login and appropriate permissions. Only allowed for order approvals in 'open', 'pending', or 'approved' state.

Authorizations

sw-context-tokenstringRequired

Path parameters

orderApprovalIdstringRequired

Order Approval ID

lineItemIdstringRequired

Line Item ID

Body

reasonstringRequired

Reason for deleting the line item

Responses

200

Line item deleted successfully

No content

400

Invalid request data or line item cannot be deleted

401

Employee not logged in

403

Employee not allowed to delete this line item

404

Order Approval or Line Item not found

post

/b2b/order-approval/{orderApprovalId}/line-items/{lineItemId}/delete

POST /b2b/order-approval/{orderApprovalId}/line-items/{lineItemId}/delete HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 17

{
  "reason": "text"
}

No content

Refresh Order Approval

post

Refreshes an order approval by recalculating prices, checking stock availability, and updating shipping costs. Detects changes and may require re-approval if significant price changes are detected.

Authorizations

sw-context-tokenstringRequired

Path parameters

orderApprovalIdstringRequired

Order Approval ID

Body

forcebooleanOptional

Force refresh even if minimum time interval has not passed (default: false)

Default: false

sendEmailOnChangesbooleanOptional

Send email notification if changes are detected (default: false)

Default: false

Responses

200

Order Approval refreshed successfully

application/json

400

Invalid request data or order approval cannot be refreshed

401

Customer not logged in

403

Customer not allowed to refresh this order approval

404

Order Approval not found

post

/b2b/order-approval/{orderApprovalId}/refresh

POST /b2b/order-approval/{orderApprovalId}/refresh HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 42

{
  "force": false,
  "sendEmailOnChanges": false
}

{
  "refreshResult": {
    "isValid": true,
    "isBlocked": true,
    "blockReasons": [
      "text"
    ],
    "hasChanges": true,
    "changes": [
      {}
    ],
    "requiresReapproval": true
  }
}

Create Order Approval from Cart

post

Creates a new Order Approval from the current shopping cart. Requires customer login.

Authorizations

sw-context-tokenstringRequired

Body

cartTokenstringRequired

Shopping cart token

customerCommentstringOptional

Optional comment from customer

Responses

200

Order Approval created successfully

application/json

anyOptional

400

Invalid request data

401

Customer not logged in

post

/order-approval/create

POST /order-approval/create HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "cartToken": "text",
  "customerComment": "text"
}

No content

List Order Approvals

post

Returns a list of Order Approvals for the logged-in customer. Supports Shopware Criteria for filtering, sorting, and pagination.

Authorizations

sw-context-tokenstringRequired

Body

anyOptional

Responses

200

Returns a list of Order Approvals

application/json

totalintegerOptional

Total count of Order Approvals

dataOrderApproval[]Optional

401

Customer not logged in

post

/order-approval/list

POST /order-approval/list HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 2

{}

{
  "total": 1,
  "data": []
}

Get Customer Order Approval Settings

get

Retrieves the order approval settings for the current customer, including approver configuration and approval mode.

Authorizations

sw-context-tokenstringRequired

Responses

200

Customer order approval settings

application/json

401

Employee not logged in

get

/b2b/order-approval/customer-settings

GET /b2b/order-approval/customer-settings HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

{
  "settings": {
    "mode": "only-admins",
    "approverEmployeeIds": [
      "text"
    ],
    "nValue": 1
  }
}

Update Customer Order Approval Settings

post

Updates the order approval settings for the current customer. Requires employee login.

Authorizations

sw-context-tokenstringRequired

Body

modestring · enumRequired

Approval mode

Possible values:

approverEmployeeIdsstring[]Optional

List of employee IDs who can approve

nValueinteger · min: 1 · nullableOptional

Required number of approvals for 'n-of' mode

Responses

200

Settings updated successfully

No content

400

Invalid request data

401

Employee not logged in

post

/b2b/order-approval/customer-settings

POST /b2b/order-approval/customer-settings HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 64

{
  "mode": "only-admins",
  "approverEmployeeIds": [
    "text"
  ],
  "nValue": 1
}

No content

Update Order Approval

post

Updates an order approval by refreshing prices and stock. This is a convenience endpoint that calls the refresh service. Requires employee login.

Authorizations

sw-context-tokenstringRequired

Path parameters

orderApprovalIdstringRequired

Order Approval ID

Responses

200

Order Approval updated successfully

No content

400

Invalid request data or order approval cannot be updated

401

Employee not logged in

403

Employee not allowed to update this order approval

404

Order Approval not found

post

/b2b/order-approval/{orderApprovalId}/update

POST /b2b/order-approval/{orderApprovalId}/update HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

No content

Get Order Approval Activity History

get

Retrieves the activity history for an order approval, including all actions, comments, and metadata.

Authorizations

sw-context-tokenstringRequired

Path parameters

orderApprovalIdstringRequired

Order Approval ID

Responses

200

Order Approval activity history

application/json

401

Customer not logged in

403

Customer not allowed to access this order approval

404

Order Approval not found

get

/b2b/order-approval/{orderApprovalId}/activity

GET /b2b/order-approval/{orderApprovalId}/activity HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

{
  "activities": [
    {
      "id": "text",
      "action": "text",
      "employeeName": "text",
      "comment": "text",
      "metadata": {},
      "createdAt": "2026-03-16T19:53:04.628Z"
    }
  ]
}

Get Approver Status

get

Retrieves the status of all approvers for an order approval, including who has approved, declined, or is still pending.

Authorizations

sw-context-tokenstringRequired

Path parameters

orderApprovalIdstringRequired

Order Approval ID

Responses

200

Approver status

application/json

401

Customer not logged in

403

Customer not allowed to access this order approval

404

Order Approval not found

get

/b2b/order-approval/{orderApprovalId}/approvers

GET /b2b/order-approval/{orderApprovalId}/approvers HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

{
  "approverStatus": {
    "approvers": [
      {
        "employeeId": "text",
        "employeeName": "text",
        "status": "pending",
        "canApprove": true
      }
    ],
    "isApproved": true,
    "isDeclined": true
  }
}

Get Order Approval Details

get

Retrieves detailed information about a specific order approval, including line items, approvers, and status.

Authorizations

sw-context-tokenstringRequired

Path parameters

orderApprovalIdstringRequired

Order Approval ID

Responses

200

Order Approval details

application/json

anyOptional

401

Customer not logged in

403

Customer not allowed to access this order approval

404

Order Approval not found

get

/b2b/order-approval/{orderApprovalId}

GET /b2b/order-approval/{orderApprovalId} HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

No content

Decline Order Approval

post

Declines an order approval request. Requires employee login and appropriate permissions.

Authorizations

sw-context-tokenstringRequired

Path parameters

orderApprovalIdstringRequired

Order Approval ID

Body

commentstringRequired

Required comment explaining the decline reason

ccEmployeeIdsstring[]Optional

Optional list of employee IDs to CC in the decline notification

Responses

200

Order Approval declined successfully

application/json

anyOptional

400

Invalid request data or order approval cannot be declined

401

Employee not logged in

403

Employee not allowed to decline this order approval

404

Order Approval not found

post

/b2b/order-approval/{orderApprovalId}/decline

POST /b2b/order-approval/{orderApprovalId}/decline HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "comment": "text",
  "ccEmployeeIds": [
    "text"
  ]
}

No content

Approve Order Approval

post

Approves an order approval request. Requires employee login and appropriate permissions.

Authorizations

sw-context-tokenstringRequired

Path parameters

orderApprovalIdstringRequired

Order Approval ID

Body

commentstringOptional

Optional comment for the approval

ccEmployeeIdsstring[]Optional

Optional list of employee IDs to CC in the approval notification

Responses

200

Order Approval approved successfully

application/json

anyOptional

400

Invalid request data or order approval cannot be approved

401

Employee not logged in

403

Employee not allowed to approve this order approval

404

Order Approval not found

post

/b2b/order-approval/{orderApprovalId}/approve

POST /b2b/order-approval/{orderApprovalId}/approve HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "comment": "text",
  "ccEmployeeIds": [
    "text"
  ]
}

No content

Get Budget Summary for Order Approvals

get

Retrieves a summary of order approvals that are using a specific budget, including total reserved amounts and pending approvals.

Authorizations

sw-context-tokenstringRequired

Path parameters

budgetIdstringRequired

Budget ID

Responses

200

Budget summary

application/json

401

Employee not logged in

404

Budget not found

get

/b2b/order-approval/budget/{budgetId}/summary

GET /b2b/order-approval/budget/{budgetId}/summary HTTP/1.1
sw-context-token: YOUR_API_KEY
Accept: */*

{
  "budgetSummary": {
    "budgetId": "text",
    "totalReserved": 1,
    "pendingApprovals": 1,
    "orderApprovals": [
      {}
    ]
  }
}

Update Order Approval Line Item

patch

Updates a line item in an order approval (e.g., quantity). Requires employee login and appropriate permissions. Only allowed for order approvals in 'open', 'pending', or 'approved' state.

Authorizations

sw-context-tokenstringRequired

Path parameters

orderApprovalIdstringRequired

Order Approval ID

lineItemIdstringRequired

Line Item ID

Body

quantitynumberRequired

New quantity for the line item

Responses

200

Line item updated successfully

No content

400

Invalid request data or line item cannot be updated

401

Employee not logged in

403

Employee not allowed to update this line item

404

Order Approval or Line Item not found

patch

/b2b/order-approval/{orderApprovalId}/line-items/{lineItemId}

PATCH /b2b/order-approval/{orderApprovalId}/line-items/{lineItemId} HTTP/1.1
sw-context-token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "quantity": 1
}

No content

Last updated 21 days ago

Was this helpful?

hashtagCount Pending Order Approvals

hashtagExecute Order Approval

hashtagUpdate Pending Order Approvals with New Settings

hashtagRemind Single Approver

hashtagRemind All Approvers

hashtagDelete Order Approval Line Item

hashtagRefresh Order Approval

hashtagCreate Order Approval from Cart

hashtagList Order Approvals

hashtagGet Customer Order Approval Settings

hashtagUpdate Customer Order Approval Settings

hashtagUpdate Order Approval

hashtagGet Order Approval Activity History

hashtagGet Approver Status

hashtagGet Order Approval Details

hashtagDecline Order Approval

hashtagApprove Order Approval

hashtagGet Budget Summary for Order Approvals

hashtagUpdate Order Approval Line Item

Count Pending Order Approvals

Execute Order Approval

Update Pending Order Approvals with New Settings

Remind Single Approver

Remind All Approvers

Delete Order Approval Line Item

Refresh Order Approval

Create Order Approval from Cart

List Order Approvals

Get Customer Order Approval Settings

Update Customer Order Approval Settings

Update Order Approval

Get Order Approval Activity History

Get Approver Status

Get Order Approval Details

Decline Order Approval

Approve Order Approval

Get Budget Summary for Order Approvals

Update Order Approval Line Item