Class ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder

Index

Constructors

Properties

Methods

Constructors

constructor

new ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder(
    args: {
        baseUri?: string;
        executeRequest: executeRequest;
        pathArgs: { projectKey: string };
    },
): ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder
Parameters
- args: {
      baseUri?: string;
      executeRequest: executeRequest;
      pathArgs: { projectKey: string };
  }
Returns ByProjectKeyShippingMethodsMatchingOrdereditRequestBuilder
- Defined in generated/client/matching-orderedit/by-project-key-shipping-methods-matching-orderedit-request-builder.ts:12

Properties

`Protected` `Readonly`args

args: {
    baseUri?: string;
    executeRequest: executeRequest;
    pathArgs: { projectKey: string };
}

Methods

get

get(
    methodArgs: {
        headers?: { [key: string]: string | string[] };
        queryArgs: {
            country: string;
            orderEditId: string;
            state?: string;
            [key: string]: QueryParam;
        };
    },
): ApiRequest<ShippingMethodPagedQueryResponse>
Retrieves the active ShippingMethods that can ship to the provided Location for an OrderEdit.
```
If a matching ShippingMethod has `isDefault` set to `true`, it is returned as the first item in the array.

If the OrderEdit preview cannot be generated, an [EditPreviewFailed](ctp:api:type:EditPreviewFailedError) error is returned.
```
Parameters
- methodArgs: {
      headers?: { [key: string]: string | string[] };
      queryArgs: {
          country: string;
          orderEditId: string;
          state?: string;
          [key: string]: QueryParam;
      };
  }
Returns ApiRequest<ShippingMethodPagedQueryResponse>
- Defined in generated/client/matching-orderedit/by-project-key-shipping-methods-matching-orderedit-request-builder.ts:29

head

head(
    methodArgs: {
        headers?: { [key: string]: string | string[] };
        queryArgs: {
            country: string;
            orderEditId: string;
            state?: string;
            [key: string]: QueryParam;
        };
    },
): ApiRequest<void>
Checks if an active ShippingMethod that can ship to the provided Location exists for the provided OrderEdit. Returns a 200 OK status if the ShippingMethod exists or a Not Found error otherwise.
Parameters
- methodArgs: {
      headers?: { [key: string]: string | string[] };
      queryArgs: {
          country: string;
          orderEditId: string;
          state?: string;
          [key: string]: QueryParam;
      };
  }
Returns ApiRequest<void>
- Defined in generated/client/matching-orderedit/by-project-key-shipping-methods-matching-orderedit-request-builder.ts:57