Skip to content

Latest commit

 

History

History
367 lines (265 loc) · 10.3 KB

OrderService.md

File metadata and controls

367 lines (265 loc) · 10.3 KB
Raw

OrderService

A list of all methods in the OrderService service. Click on the method name to view detailed information about that method.

Methods Description
list_order Retrieve a list of all orders.
create_order Create an order for goods. For services, see Create Subscription.
retrieve_order Retrieve the details of an order.
update_order Change or modify an order.
returns_order Make a return against an order. The maximum amount of the return is the amount of the order
pay_order Pay an order.
list_order_return Retrieve a list of all order returns.
retrieve_order_return Retrieve the details of a return.

list_order

Retrieve a list of all orders.

  • HTTP Method: GET
  • Endpoint: /v1/orders

Parameters

Name Type Required Description
limit str ❌ The maximum number of orders to return. Range - 1-100. Default is 10.
ending_before str ❌ The ID of the order created after the last order you want to retrieve.
starting_after str ❌ The ID of the order created before the first order you want to retrieve.

Return Type

InlineResponse200_46

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.order.list_order(
    limit="limit",
    ending_before="ending_before",
    starting_after="starting_after"
)

print(result)

create_order

Create an order for goods. For services, see Create Subscription.

  • HTTP Method: POST
  • Endpoint: /v1/orders

Parameters

Name Type Required Description
request_body V1OrdersBody ❌ The request body.

Return Type

InlineResponse200_47

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import V1OrdersBody

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

request_body = V1OrdersBody(
    coupon="coupon",
    customer="customer",
    currency="currency",
    email="email",
    items=[
        {
            "amount": "amount",
            "currency": "GBP",
            "description": "description",
            "parent": "parent",
            "type_": "shipping",
            "quantity": 0.44
        }
    ],
    metadata={},
    shipping_address={
        "canton": "canton",
        "city": "city",
        "country": "GB",
        "created_at": 3.34,
        "district": "district",
        "id_": "id",
        "line_1": "line_1",
        "line_2": "line_2",
        "line_3": "line_3",
        "metadata": {},
        "name": "name",
        "phone_number": "phone_number",
        "state": "state",
        "zip": "zip"
    },
    tax_percent=1.76,
    upstream_id="upstream_id"
)

result = sdk.order.create_order(request_body=request_body)

print(result)

retrieve_order

Retrieve the details of an order.

  • HTTP Method: GET
  • Endpoint: /v1/orders/{orderId}

Parameters

Name Type Required Description
order_id str ✅ ID of the order. String starting with order_.

Return Type

InlineResponse200_48

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.order.retrieve_order(order_id="orderId")

print(result)

update_order

Change or modify an order.

  • HTTP Method: POST
  • Endpoint: /v1/orders/{orderId}

Parameters

Name Type Required Description
request_body OrdersOrderIdBody ✅ The request body.
order_id str ✅ ID of the order. String starting with order_.

Return Type

InlineResponse200_48

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import OrdersOrderIdBody

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

request_body = OrdersOrderIdBody(
    coupon="coupon",
    metadata={},
    tax_percent=6.19,
    status="paid"
)

result = sdk.order.update_order(
    request_body=request_body,
    order_id="orderId"
)

print(result)

returns_order

Make a return against an order. The maximum amount of the return is the amount of the order

  • HTTP Method: POST
  • Endpoint: /v1/orders/{orderId}/returns

Parameters

Name Type Required Description
request_body OrderIdReturnsBody ✅ The request body.
order_id str ✅ ID of the order. String starting with order_.

Return Type

InlineResponse200_49

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import OrderIdReturnsBody

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

request_body = OrderIdReturnsBody(
    order_id="order_id",
    items=[
        {
            "description": "description",
            "parent": "parent",
            "type_": "sku",
            "quantity": 9.55,
            "currency": "currency",
            "amount": 7.78,
            "order_id": "order_id"
        }
    ]
)

result = sdk.order.returns_order(
    request_body=request_body,
    order_id="orderId"
)

print(result)

pay_order

Pay an order.

  • HTTP Method: POST
  • Endpoint: /v1/orders/{orderId}/pay

Parameters

Name Type Required Description
request_body OrderIdPayBody ✅ The request body.
order_id str ✅ ID of the order. String starting with order_.

Return Type

InlineResponse200_48

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment
from rapyd_sdk.models import OrderIdPayBody

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

request_body = OrderIdPayBody(
    metadata={},
    payment_method="payment_method",
    customer="customer"
)

result = sdk.order.pay_order(
    request_body=request_body,
    order_id="orderId"
)

print(result)

list_order_return

Retrieve a list of all order returns.

  • HTTP Method: GET
  • Endpoint: /v1/order_returns

Parameters

Name Type Required Description
limit str ❌ The maximum number of returns to list. Range - 1-100. Default is 10.
ending_before str ❌ The ID of the order created after the last order you want to retrieve a return from.
starting_after str ❌ The ID of the order created before the first order you want to retrieve a return from.
tokens List[str] ❌ Filters the list for orders related to the specified order.

Return Type

InlineResponse200_50

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)
tokens=[
    "tokens"
]

result = sdk.order.list_order_return(
    limit="limit",
    ending_before="ending_before",
    starting_after="starting_after",
    tokens=tokens
)

print(result)

retrieve_order_return

Retrieve the details of a return.

  • HTTP Method: GET
  • Endpoint: /v1/order_returns/{orderReturnsId}

Parameters

Name Type Required Description
order_returns_id str ✅ ID of the return. String starting with orre_.

Return Type

InlineResponse200_49

Example Usage Code Snippet

from rapyd_sdk import RapydSdk, Environment

sdk = RapydSdk(
    base_url=Environment.DEFAULT.value,
    timeout=10000
)

result = sdk.order.retrieve_order_return(order_returns_id="orderReturnsId")

print(result)