You are reading the documentation for v7.x and earlier, which is no longer the latest version. Switch to v8.x
getBranchOrder
Get single B2B order from the user's organization's branch
Make sure that the B2B user calling this method is in the Unit Order Viewer group. This will make the user have the correct permissions to call this endpoint.
This method exchanges data with the getBranchOrder endpoint exposed by the SAP OCC API .
Signature
export declare function getBranchOrder(
context: SapccIntegrationContext,
props: GetBranchOrderProps
): Promise<Order>;Parameters
| Name | Required | Type | Description |
|---|---|---|---|
context | Required | SapccIntegrationContext | |
props | Required | GetBranchOrderProps | Parameter object which can be used with this method. Refer to its type definition to learn about possible properties. |
Returns
Returns one B2B order with the requested ID from the user's organization's unit
Referenced Types
- SapccIntegrationContext
GetBranchOrderProps- Order
Examples
Requesting a single order from the user's organization's branch
import { sdk } from '~/sdk';
const props = { code: "00001234" };
const order = await sdk.commerce.getBranchOrder(props);