PatchRequest

@objc(PPCPatchRequest)
@objcMembers
class PatchRequest

extension PatchRequest : CVarArg, CustomDebugStringConvertible, CustomStringConvertible, Equatable, Hashable, NSObjectProtocol

Represents each operation and their accepted path, as well as the paths accepted value for each type. Patch Order Documentation

Note

To make an update, you may optionally provide a reference_id. If you omit a reference_id, PayPal defaults to a reference_id of default.


                    
                    
                    add(shippingAddress:referenceId:)

Adds a shippingAddress to the order request.

Swift

func add(shippingAddress: OrderAddress, referenceId: String? = nil)

`shippingAddress`	The address of the person to whom to ship the items.
`referenceId`	The API caller-provided external ID for the purchase unit if more than one purchase unit was provided.


                    
                    
                    add(shippingName:referenceId:)

Adds a shippingName to the order request.

Swift

func add(shippingName: PurchaseUnit.ShippingName, referenceId: String? = nil)

`shippingName`	The name of the person to whom to ship the items. Supports only the `full_name` property.
`referenceId`	The API caller-provided external ID for the purchase unit if more than one purchase unit was provided.


                    
                    
                    add(shippingOptions:referenceId:)

Adds shippingOptions to the order request

Swift

func add(shippingOptions: [ShippingMethod], referenceId: String? = nil)

`shippingOptions`	A list of shipping options for the order.
`referenceId`	The API caller-provided external ID for the purchase unit if more than one purchase unit was provided.


                    
                    
                    replace(amount:referenceId:)

Replaces the amount of the order request.

Swift

func replace(amount: PurchaseUnit.Amount, referenceId: String? = nil)

`amount`	The total order amount with an optional breakdown that provides details, such as the total item amount, total tax amount, shipping, handling, insurance, and discounts, if any.
`referenceId`	The API caller-provided external ID for the purchase unit if more than one purchase unit was provided.


                    
                    
                    replace(shippingAddress:referenceId:)

Replaces the shippingAddress of the order request.

Swift

func replace(shippingAddress: OrderAddress, referenceId: String? = nil)

`shippingAddress`	The address of the person to whom to ship the items.
`referenceId`	The API caller-provided external ID for the purchase unit if more than one purchase unit was provided.


                    
                    
                    replace(shippingName:referenceId:)

Replaces the shippingName of the order request.

Swift

func replace(shippingName: PurchaseUnit.ShippingName, referenceId: String? = nil)

`shippingName`	The name of the person to whom to ship the items. Supports only the `full_name` property.
`referenceId`	The API caller-provided external ID for the purchase unit if more than one purchase unit was provided.


                    
                    
                    replace(shippingOptions:referenceId:)

Replaces the shippingOptions of the order request.

Swift

func replace(shippingOptions: [ShippingMethod], referenceId: String? = nil)

`shippingOptions`	A list of shipping options for the order.
`referenceId`	The API caller-provided external ID for the purchase unit if more than one purchase unit was provided.