Create Order

In this article

Overview

You can use this Snap to create an order (created by customer) or a draft order (created by merchant on behalf of the customer).

Prerequisites

None.

Support for Ultra Pipelines

Works in Ultra Pipelines

Limitations

  • API versions: Shopify releases new API versions every quarter. Each stable version is supported only for a minimum of 12 months. Part of a Shopify API is deprecated if it becomes unnecessary, unsafe, or outdated. The API’s are marked as deprecated when they are removed in a newer version of the API. The deprecation is then retroactively applied to previous stable versions of the API.
  • API Rate Limit: All Shopify APIs are rate-limited. Shopify uses various strategies to enforce rate limits, such as Calculated query cost, Request-based limit, and Time-based limit. 
    Shopify Snap Pack uses admin APIs, which are applicable for Request-based limit. If the APIs cross the rate limit, the Snap fails.

    API

    Rate-limiting method

    Standard limit

    Shopify Plus limit

    Admin API

    (GraphQL)

    Calculated query cost

    50 points/second

    100 points/second

    Admin API

     (REST)

    Request-based limit

    2 requests/second

    4 requests/second

Shopify Behavior

  • When you create an order for a product, you cannot apply discount on a line item. If the associated discount application is of type code, the Snap returns the discount code that was entered at checkout. Else, the Snap returns the title of the discount that was applied. See Discount APIs for more information.
  • This Snap ignores invalid values, such as shipping and billing phone number and does not validate correctly.
  • Taxes are applied on line items and on orders, but Shopify documentation mentions it should be applied for either of the one.

Known Issues

None.

Snap Input and Output

Input/OutputType of ViewNumber of ViewsExamples of Upstream and Downstream SnapsDescription
Input 

Document


  • Min:1
  • Max:1
  • Mapper
  • Copy

Attributes of the order, such as first name, last name, billing address, product, variant, and discount (if any) on the product.

Output

Document


  • Min:1
  • Max:1
  • Mapper
  • JSON Generator

The created order that meet the specified criteria.

Snap Settings

Field NameField DependencyDescription
Label*N/A
Specify the name for the Snap. You can modify the default name to be specific and meaningful, especially if you have more than one of the same Snap in your Pipeline.

Default Value: Create Order
Example: Create_Order_891
Version*N/A

Specify the Shopify API version. Alternatively, click the Suggestion  icon to fetch the list of Shopify API versions. 
The schema is static and is captured from the 2021-04 version of Shopify. See Shopify REST APIs for more information.

Default Value2021-07
Example2021-04

Draft OrdersN/A

Specify a draft order ID to create a draft order.

Default Value: N/A (Expression enabled by default)
Example: ord_98
Number Of RetriesN/A

Specify an integer value to set the maximum number of reconnection attempts that the Snap must perform, in case of connection failure or timeout.

Default Value: 1
Example: 2
Retry Interval (Seconds)N/A

Specify the duration in seconds for which the Snap must wait between two reconnection attempts, until the number of retries is reached.

Default Value: 1
Example: 2
Snap Execution

N/A


Select one of the three modes in which the Snap executes. Available options are:

  • Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
  • Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
  • Disabled: Disables the Snap and all Snaps that are downstream from it.


Default Value: 
Execute only 
Example: Validate & Execute


Troubleshooting

ErrorReasonResolution

"402 Payment Required"

The requested shop is currently frozen. You need to log in as admin user and pay the outstanding balance to unfreeze the shop.
"404 Not Found"The requested resource is not found.The resource could be available again in the future.

"406 Not Acceptable"

The requested resource is only capable of generating content, but not acceptable according to the Accept headers sent in the request.N/A
"409 error"This is an intermittent error that you can encounter when there is a conflict in your orders, products, or customer data. For example, when you use unsupported characters.Check for the conflicts in your metadata and rerun the Pipeline.
"422 Unprocessable Entity"

The request body was well-formed but contains semantic errors. You can encounter a 422 error from a variety of scenarios including, but not limited to:

  • Formatting of the input is incorrect.

  • Checking out products that are out of stock.

  • Canceling an order that has fulfillments.

  • Creating an order with tax lines on both line items and the order.

  • Creating a customer without an email or name

  • Creating a product without a title.

The response body provides details in the errors or error parameters. Fix the error parameters as given in the error description.
"422 empty entity error"You might be sending null or empty or unsupported data. Check the data and fix the null or empty data.

"423 locked"

The requested shop is currently locked. Shops are locked if they repeatedly exceed their API request limit, or if there is an issue with the account, such as a detected compromise or fraud risk.

Wait for Shopify to unlock your account after the specified amount of time, after which you should be able to continue working on your Pipeline, or contact support if your shop is locked.

"429 Too Many Requests"Shopify APIs use different API rate-limiting methods. If the APIs exceeds the rate limit, the Snap fails.See the API Call Limit documentation for a breakdown of Shopify's rate-limiting mechanism.
"500 Internal Server Error"An internal error in Shopify application causes this error. Post the error details to the API and Technology forum so that Shopify staff can investigate the issue.

"501 Not Implemented"

The requested endpoint is not available on that particular shop, for example, requesting access to a Plus-specific API on a non-Plus shop. This response may also indicate that this endpoint is reserved for future use.N/A
"504 Gateway Timeout"The request could not complete in time. Shopify waits up to 10 seconds for a response.Break down the request in multiple smaller requests.

Example

Creating An Order

This example Pipeline demonstrates how to create an order in the store using the Create Order Snap.

Initially, we configure the JSON Generator Snap to pass order details. Upon validation we see the following order details in the output preview of the Snap.

Order DetailsOrder Details Output

Next, we configure the Mapper Snap as follows to pass the order details to the downstream Snap.

Upon validation, we see the following data in the output preview of the Snap.

Next, we configure the Create Order Snap to create an order with the output from the Mapper Snap.

Upon validation, the Snap creates an order and we can view the order data in the output preview of the Snap.

You can extend this Pipeline further to create fulfillments or update an existing order.

Download this Pipeline.

  File Modified

File Example_Shopify_Create_Order.slp

Aug 12, 2021 by Kalpana Malladi


Snap Pack History

 Click here to expand...
Snap Pack Version 

Release

Date

Type

Updates

4.29main15993 StableUpgraded with the latest SnapLogic Platform release.
4.28main14627 StableUpgraded with the latest SnapLogic Platform release.
4.27main12833 StableUpgraded with the latest SnapLogic Platform release.
4.26 

main11181

Latest

Introduced the Shopify Snap Pack that enables businesses to set up an online store and sell their products online with ease. You can use this Snap Pack to create orders, products, customers, and run automated workflows. This Snap Pack offers the following Snaps:


See Also