Skip to main content

Getting Started with Orders

Introduction

An order represents a payment between two or more parties. Use the Orders API to create, update, retrieve, authorize, and capture orders.

Find out more here: https://developer.paypal.com/docs/api/orders/v2/

Install the Package

The package is compatible with Python versions 3.7+. Install the package from PyPi using the following pip command:

pip install pp-api-sdk==1.0.0

You can also view the package at: https://pypi.python.org/pypi/pp-api-sdk/1.0.0

Initialize the API Client

Note: Documentation for the client can be found here.

The following parameters are configurable for the API Client:

Parameter Type Description
environment Environment The API environment.
Default: Environment.PRODUCTION
http_client_instance HttpClient The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ['GET', 'PUT']
client_credentials_auth_credentials ClientCredentialsAuthCredentials The credential object for OAuth 2 Client Credentials Grant

The API client can be initialized as follows:

from orders.configuration import Environment
from orders.http.auth.o_auth_2 import ClientCredentialsAuthCredentials
from orders.orders_client import OrdersClient

client = OrdersClient(
    client_credentials_auth_credentials=ClientCredentialsAuthCredentials(
        o_auth_client_id='OAuthClientId',
        o_auth_client_secret='OAuthClientSecret'
    ),
    environment=Environment.PRODUCTION
)

Environments

The SDK can be configured to use a different environment for making API calls. Available environments are:

Fields

Name Description
production Default PayPal Sandbox Environment
environment2 PayPal Live Environment

Authorization

This API uses the following authentication schemes.

List of APIs

SDK Infrastructure

HTTP

Utilities

Metadata

Release files for pp-api-sdk 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pp-api-sdk 1.0.0
File Size Uploaded Provenance Actions
pp_api_sdk-1.0.0.tar.gz 166.4 kB Without provenance Details for pp_api_sdk-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pp-api-sdk 1.0.0
File Interpreter ABI Platform Actions
pp_api_sdk-1.0.0-py3-none-any.whl Python 3 none any Details for pp_api_sdk-1.0.0-py3-none-any.whl

Total release size: 508.1 kB

Release files / pp_api_sdk-1.0.0.tar.gz

Download URL pp_api_sdk-1.0.0.tar.gz
Size 166.4 kB
Tags Source
SHA-256 checksum
How to use checksums
32ba59a6c91c5be5da27b7d2db74817f594bd84b8cddbf84f62c403e5b3eb7f4
BLAKE2b-256 checksum
How to use checksums
5259a4c2f6266340dd3254f07c6a243344711c953a0a4c6dbfde045b7371b2c4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Release files / pp_api_sdk-1.0.0-py3-none-any.whl

Download URL pp_api_sdk-1.0.0-py3-none-any.whl
Size 341.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
625ab6416bf869b41d44a9673421787d05171796a5be27432d359b28a602626d
BLAKE2b-256 checksum
How to use checksums
5f9c397f24a40f32eedfc0dc70ae265387f859944963c2c26c04226ae8bbef24
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.9.13

Security for pp-api-sdk 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.0.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page