Mock sample for your project: Fulfillment.com APIv2
Integrate with "Fulfillment.com APIv2" from fulfillment.com in no time with Mockoon's ready to use mock sample
Fulfillment.com APIv2
Version: 2.0
Start working with "Fulfillment.com APIv2" right away by using this ready-to-use mock sample. API mocking can greatly speed up your application development by removing all the tedious tasks or issues: API key provisioning, account creation, unplanned downtime, etc.
It also helps reduce your dependency on third-party APIs and improves your integration tests' quality and reliability by accounting for random failures, slow response time, etc.
Description
Welcome to our current iteration of our REST API. While we encourage you to upgrade to v2.0 we will continue support for our SOAP API.
Versioning
The Fulfillment.com (FDC) REST API is version controlled and backwards compatible. We have many future APIs scheduled for publication within our v2.0 spec so please be prepared for us to add data nodes in our responses, however, we will not remove knowledge from previously published APIs.
A Current Response
Status Codes
Codes are a concatenation of State, Stage, and Detail.
^([0-9]{2})([0-9]{2})([0-9]{2})$
| Code | State | Stage | Detail |
| ---- | ------------------ | -------- | -------------- |
| 010101 | Processing Order | Recieved | Customer Order |
| 010102 | Processing Order | Recieved | Recieved |
| 010201 | Processing Order | Approved | |
| 010301 | Processing Order | Hold | Merchant Stock |
| 010302 | Processing Order | Hold | Merchant Funds |
| 010303 | Processing Order | Hold | For Merchant |
| 010304 | Processing Order | Hold | Oversized Shipment |
| 010305 | Processing Order | Hold | Invalid Parent Order |
| 010306 | Processing Order | Hold | Invalid Address |
| 010307 | Processing Order | Hold | By Admin |
| 010401 | Processing Order | Address Problem | Incomplete Address |
| 010402 | Processing Order | Address Problem | Invalid Locality |
| 010403 | Processing Order | Address Problem | Invalid Region |
| 010404 | Processing Order | Address Problem | Address Not Found |
| 010405 | Processing Order | Address Problem | Many Addresses Found |
| 010406 | Processing Order | Address Problem | Invalid Postal Code |
| 010407 | Processing Order | Address Problem | Country Not Mapped |
| 010408 | Processing Order | Address Problem | Invalid Recipient Name |
| 010409 | Processing Order | Address Problem | Bad UK Address |
| 010410 | Processing Order | Address Problem | Invalid Address Line 1 or 2 |
| 010501 | Processing Order | Sku Problem | Invalid SKU |
| 010501 | Processing Order | Sku Problem | Child Order has Invalid SKUs |
| 010601 | Processing Order | Facility Problem | Facility Not Mapped |
| 010701 | Processing Order | Ship Method Problem | Unmapped Ship Method |
| 010702 | Processing Order | Ship Method Problem | Unmapped Ship Cost |
| 010703 | Processing Order | Ship Method Problem | Missing Ship Method |
| 010704 | Processing Order | Ship Method Problem | Invalid Ship Method |
| 010705 | Processing Order | Ship Method Problem | Order Weight Outside of Ship Method Weight |
| 010801 | Processing Order | Inventory Problem | Insufficient Inventory In Facility |
| 010802 | Processing Order | Inventory Problem | Issue Encountered During Inventory Adjustment |
| 010901 | Processing Order | Released To WMS | Released |
| 020101 | Fulfillment In Progress | Postage Problem | Address Issue |
| 020102 | Fulfillment In Progress | Postage Problem | Postage OK, OMS Issue Occurred |
| 020103 | Fulfillment In Progress | Postage Problem | Postage Void Failed |
| 020201 | Fulfillment In Progress | Postage Acquired | |
| 020301 | Fulfillment In Progress | Postage Voided | Postage Void Failed Gracefully |
| 020301 | Fulfillment In Progress | Hold | Departure Hold Requested |
| 020401 | Fulfillment In Progress | 4PL Processing | |
| 020501 | Fulfillment In Progress | 4PL Problem | Order is Proccessable, Postage Issue Occurred |
| 020601 | Fulfillment In Progress | Label Printed | |
| 020701 | Fulfillment In Progress | Shipment Cubed | |
| 020801 | Fulfillment In Progress | Picking Inventory | |
| 020901 | Fulfillment In Progress | Label Print Verified | |
| 021001 | Fulfillment In Progress | Passed Final Inspection | |
| 030101 | Shipped | Fulfilled By 4PL | |
| 030102 | Shipped | Fulfilled By 4PL | Successfully Fulfilled, OMS Encountered Issue During Processing |
| 030201 | Shipped | Fulfilled By FDC | |
| 040101 | Returned | Returned | |
| 050101 | Cancelled | Cancelled | |
| 060101 | Test | Test | Test |
Other APIs in the same category
Item API
Pims
Authentication
The API uses basic access authentication, meaning you will need a username and password to get authorized.
As each customer in Pims has its own domain (e.g. caramba.pims.io, gdp.pims.io...), each credentials will be valid for one domain/customer only. If you need dedicated credentials for one domain, please contact us. (In any case, we will need an explicit agreement from the customer before we create these credentials.)
To make your life easy, you can try all endpoints with the public credentials below, pointing to our demo domain:
Base path: https://demo.pims.io/api
Username: demo
Password: q83792db2GCvgYVdKpU3yG3R
Response format
The API returns JSON and matches the HAL specification. The Content-Type of each response will be application/hal+json, unless an error occurs.
Please note that this documentation describes all responses “as if” they were plain JSON. The specificities of HAL are ignored on purpose, in order to remain compact and avoid repetition.
So when you read in the doc:
{"id" : 123,"property1" :"Lorem ipsum","object" : {"id" : 456,"property2" : 7.89
}
}
... you'll get in the Real World®:
{"id" : 123,"property2" :"Lorem ipsum","embedded" : {"object" : {"id" : 456,"property2" : 7.89,"links" : {"self" : {"href" :"https://api.mydomain.com/other-item/456"
}
}
}
}"_links" : {"self" : {"href" :"https://api.mydomain.com/item/123"
}
}
}
Errors
Errors return JSON too and tries to match the Problem Details for HTTP APIs specification. If it does not match this spec, that's either a bug or a compatibility issue. Please contact us to solve the problem.
The Content-Type of errors will be application/problem+json. The content will match the following JSON:
Filtering and sorting
Every textual filter (e.g. /events?label=U2) and/or sort (e.g. /events?sort=label) performed with the API uses UTF8UNICODECI collation, meaning it is:
Case insensitive: “Chloé” will be considered the same as “CHLOÉ”;
Diacritic insensitive: “Chloé” will be considered the same as “Chloe”.
When performing a sort, it will always be ascending by default. To make it descending, just use a minus sign (-) in front of the parameter value (e.g. /events?sort=-label).
I18n
In responses, some labels can be translated (e.g. promotion types, event input types, etc.). These translatable labels are clearly indicated in the documentation below.
By default, they will be displayed in English, but you can change this behaviour via the Accept-Language header. E.g., use fr as a value for French.
PHP SDK
We provide a simple yet convenient SDK for the PHP language, see the Github page of the project.
And now?
Generaly, you will start by fetching one or more events. An event can be anything that occurs in one venue at one given date and time: a concert, a play, a match, a conference, etc. Additionnally, you can explore the series: a series is just a group of events (e.g. a tour or a festival).
Once you retrieved the events you were interested in, you can look for the sales ( ticket counts):
Get a quick overview with /events/:id/ticket-counts
Or get a full insight by calling these endpoints:
/events/:id/categories
/events/:id/channels
/events/:id/ticket-counts/detailed
Eventually, you may also want to fetch the promotions. A promotion can be anything meant to leverage the sales: ads, marketing campaigns, buzz or news around the event, etc. A promotion can be linked to any combination of events and/or series.
ChannelShipper & Royal Mail Public API
agentOS Api V2, Customer Login Call Group
Zettle Product Library API
displayed, put in a shopping cart and sold to a customer. Items may be
either producs or discounts.
A product is a synthetic construct, wrapping one or more variants (which is
the actual item being sold) Variants expresses different variations of
properties such as for example price, size or color. A discount will reduce
the total amount charged in a shopping cart. It can be used per item line,
or on the whole cart. It may reduce the affected amount by a percentage, or
by a fixed amount.
Together, the above types of entities makes up a complete library. The
library can be fetched as a whole through the library endpoint, where each
consecutive change applied to the library is available. Once the full
library is retrieved, only later events needs to be fetched to keep the
client up to date with the server
All path patterns "/organizations/{organizationUuid}/" can be replaced
with "/organizations/self/" for convenience as all endpoints are for
authorized users.
Zalando Shop
Inventory Management
Price Management
LetMC Api V3, reporting
カラーミーショップアプリストア API
アプリストアにて公開するアプリに対して、一般公開しているカラーミーショップAPIに加えて、カラーミーショップアプリストアAPI（以下、アプリストアAPIといいます）を利用することが出来ます。アプリストアAPIでは以下のことが行えます。
課金データ(アプリ内課金、従量課金)の作成
インラインスクリプトタグの取得・作成・更新・削除
スクリプトタグの取得・作成・更新・削除
利用手順
アプリストアAPIを利用するには、OAuth認証が必要です。OAuth認証の基本的な流れについてはカラーミーショップAPIドキュメントを参照してください。
アプリストアAPIの利用のために、以下のscopeが追加で指定可能になります。カラーミーショップAPIドキュメントに掲載されているscopeと合わせてご利用ください。
|スコープ|機能|
|---|---|
|writeapplicationcharge|課金データの作成|
|readshopscript_tags|ショップページのスクリプトタグを参照|
|writeshopscript_tags|ショップページへスクリプトタグを追加・更新|
|readinlinescript_tags|インラインスクリプトタグを参照|
|writeinlinescript_tags|インラインスクリプトタグを追加・更新|
|readscripttags|スクリプトタグを参照(deprecated)|
|writescripttags|スクリプトタグを追加・更新(deprecated)|
(例) カラーミーショップアカウントの認証ページを表示
FraudLabs Pro SMS Verification
